Statistics
| Branch: | Revision:

root / qemu-options.hx @ 17b6dea0

History | View | Annotate | Download (77.8 kB)

1
HXCOMM Use DEFHEADING() to define headings in both help text and texi
2
HXCOMM Text between STEXI and ETEXI are copied to texi version and
3
HXCOMM discarded from C version
4
HXCOMM DEF(option, HAS_ARG/0, opt_enum, opt_help, arch_mask) is used to
5
HXCOMM construct option structures, enums and help message for specified
6
HXCOMM architectures.
7
HXCOMM HXCOMM can be used for comments, discarded from both texi and C
8

    
9
DEFHEADING(Standard options:)
10
STEXI
11
@table @option
12
ETEXI
13

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

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

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

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

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

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

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

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

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

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

    
129
Define a new drive. Valid options are:
130

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

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

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

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

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

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

    
190
Instead of @option{-cdrom} you can use:
191
@example
192
qemu -drive file=file,index=2,media=cdrom
193
@end example
194

    
195
Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
196
use:
197
@example
198
qemu -drive file=file,index=0,media=disk
199
qemu -drive file=file,index=1,media=disk
200
qemu -drive file=file,index=2,media=disk
201
qemu -drive file=file,index=3,media=disk
202
@end example
203

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

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

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

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

    
225
By default, @var{interface} is "ide" and @var{index} is automatically
226
incremented:
227
@example
228
qemu -drive file=a -drive file=b"
229
@end example
230
is interpreted like:
231
@example
232
qemu -hda a -hdb b
233
@end example
234
ETEXI
235

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    
370

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

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

    
392
@example
393
qemu -soundhw sb16,adlib disk.img
394
qemu -soundhw es1370 disk.img
395
qemu -soundhw ac97 disk.img
396
qemu -soundhw all disk.img
397
qemu -soundhw ?
398
@end example
399

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

    
403
@example
404
modprobe i810_audio clocking=48000
405
@end example
406
ETEXI
407

    
408
STEXI
409
@end table
410
ETEXI
411

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

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

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

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

    
433
@table @option
434

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

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

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

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

    
451
@item host:@var{vendor_id}:@var{product_id}
452
Pass through the host device identified by @var{vendor_id}:@var{product_id}
453
(Linux only).
454

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

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

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

    
466
@end table
467
ETEXI
468

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

    
485
DEFHEADING(File system options:)
486

    
487
DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev,
488
    "-fsdev local,id=id,path=path,security_model=[mapped|passthrough|none]\n",
489
    QEMU_ARCH_ALL)
490

    
491
STEXI
492

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

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

    
502
Options to each backend are described below.
503

    
504
@item -fsdev local ,id=@var{id} ,path=@var{path} ,security_model=@var{security_model}
505

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

    
508
@option{local} is only available on Linux.
509

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

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

    
515
@end table
516
ETEXI
517

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

    
520
DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs,
521
    "-virtfs local,path=path,mount_tag=tag,security_model=[mapped|passthrough|none]\n",
522
    QEMU_ARCH_ALL)
523

    
524
STEXI
525

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

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

    
535
Options to each backend are described below.
536

    
537
@item -virtfs local ,path=@var{path} ,mount_tag=@var{mount_tag} ,security_model=@var{security_model}
538

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

    
541
@option{local} is only available on Linux.
542

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

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

    
548

    
549
@option{mount_tag} specifies the tag with which the exported file is mounted.
550
@option{mount_tag} is required.
551

    
552
@end table
553
ETEXI
554

    
555
DEFHEADING()
556

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

    
571
DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
572
    "-uuid %08x-%04x-%04x-%04x-%012x\n"
573
    "                specify machine UUID\n", QEMU_ARCH_ALL)
574
STEXI
575
@item -uuid @var{uuid}
576
@findex -uuid
577
Set system UUID.
578
ETEXI
579

    
580
STEXI
581
@end table
582
ETEXI
583

    
584
DEFHEADING()
585

    
586
DEFHEADING(Display options:)
587

    
588
STEXI
589
@table @option
590
ETEXI
591

    
592
DEF("nographic", 0, QEMU_OPTION_nographic,
593
    "-nographic      disable graphical output and redirect serial I/Os to console\n",
594
    QEMU_ARCH_ALL)
595
STEXI
596
@item -nographic
597
@findex -nographic
598
Normally, QEMU uses SDL to display the VGA output. With this option,
599
you can totally disable graphical output so that QEMU is a simple
600
command line application. The emulated serial port is redirected on
601
the console. Therefore, you can still use QEMU to debug a Linux kernel
602
with a serial console.
603
ETEXI
604

    
605
#ifdef CONFIG_CURSES
606
DEF("curses", 0, QEMU_OPTION_curses,
607
    "-curses         use a curses/ncurses interface instead of SDL\n",
608
    QEMU_ARCH_ALL)
609
#endif
610
STEXI
611
@item -curses
612
@findex curses
613
Normally, QEMU uses SDL to display the VGA output.  With this option,
614
QEMU can display the VGA output when in text mode using a
615
curses/ncurses interface.  Nothing is displayed in graphical mode.
616
ETEXI
617

    
618
#ifdef CONFIG_SDL
619
DEF("no-frame", 0, QEMU_OPTION_no_frame,
620
    "-no-frame       open SDL window without a frame and window decorations\n",
621
    QEMU_ARCH_ALL)
622
#endif
623
STEXI
624
@item -no-frame
625
@findex -no-frame
626
Do not use decorations for SDL windows and start them using the whole
627
available screen space. This makes the using QEMU in a dedicated desktop
628
workspace more convenient.
629
ETEXI
630

    
631
#ifdef CONFIG_SDL
632
DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
633
    "-alt-grab       use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n",
634
    QEMU_ARCH_ALL)
635
#endif
636
STEXI
637
@item -alt-grab
638
@findex -alt-grab
639
Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt).
640
ETEXI
641

    
642
#ifdef CONFIG_SDL
643
DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab,
644
    "-ctrl-grab      use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n",
645
    QEMU_ARCH_ALL)
646
#endif
647
STEXI
648
@item -ctrl-grab
649
@findex -ctrl-grab
650
Use Right-Ctrl to grab mouse (instead of Ctrl-Alt).
651
ETEXI
652

    
653
#ifdef CONFIG_SDL
654
DEF("no-quit", 0, QEMU_OPTION_no_quit,
655
    "-no-quit        disable SDL window close capability\n", QEMU_ARCH_ALL)
656
#endif
657
STEXI
658
@item -no-quit
659
@findex -no-quit
660
Disable SDL window close capability.
661
ETEXI
662

    
663
#ifdef CONFIG_SDL
664
DEF("sdl", 0, QEMU_OPTION_sdl,
665
    "-sdl            enable SDL\n", QEMU_ARCH_ALL)
666
#endif
667
STEXI
668
@item -sdl
669
@findex -sdl
670
Enable SDL.
671
ETEXI
672

    
673
DEF("spice", HAS_ARG, QEMU_OPTION_spice,
674
    "-spice <args>   enable spice\n", QEMU_ARCH_ALL)
675
STEXI
676
@item -spice @var{option}[,@var{option}[,...]]
677
@findex -spice
678
Enable the spice remote desktop protocol. Valid options are
679

    
680
@table @option
681

    
682
@item port=<nr>
683
Set the TCP port spice is listening on for plaintext channels.
684

    
685
@item password=<secret>
686
Set the password you need to authenticate.
687

    
688
@item disable-ticketing
689
Allow client connects without authentication.
690

    
691
@item tls-port=<nr>
692
Set the TCP port spice is listening on for encrypted channels.
693

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

    
697
@item x509-key-file=<file>
698
@item x509-key-password=<file>
699
@item x509-cert-file=<file>
700
@item x509-cacert-file=<file>
701
@item x509-dh-key-file=<file>
702
The x509 file names can also be configured individually.
703

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

    
707
@item tls-channel=[main|display|inputs|record|playback|tunnel]
708
@item plaintext-channel=[main|display|inputs|record|playback|tunnel]
709
Force specific channel to be used with or without TLS encryption.  The
710
options can be specified multiple times to configure multiple
711
channels.  The special name "default" can be used to set the default
712
mode.  For channels which are not explicitly forced into one mode the
713
spice client is allowed to pick tls/plaintext as he pleases.
714

    
715
@item image-compression=[auto_glz|auto_lz|quic|glz|lz|off]
716
Configure image compression (lossless).
717
Default is auto_glz.
718

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

    
724
@end table
725
ETEXI
726

    
727
DEF("portrait", 0, QEMU_OPTION_portrait,
728
    "-portrait       rotate graphical output 90 deg left (only PXA LCD)\n",
729
    QEMU_ARCH_ALL)
730
STEXI
731
@item -portrait
732
@findex -portrait
733
Rotate graphical output 90 deg left (only PXA LCD).
734
ETEXI
735

    
736
DEF("vga", HAS_ARG, QEMU_OPTION_vga,
737
    "-vga [std|cirrus|vmware|xenfb|none]\n"
738
    "                select video card type\n", QEMU_ARCH_ALL)
739
STEXI
740
@item -vga @var{type}
741
@findex -vga
742
Select type of VGA card to emulate. Valid values for @var{type} are
743
@table @option
744
@item cirrus
745
Cirrus Logic GD5446 Video card. All Windows versions starting from
746
Windows 95 should recognize and use this graphic card. For optimal
747
performances, use 16 bit color depth in the guest and the host OS.
748
(This one is the default)
749
@item std
750
Standard VGA card with Bochs VBE extensions.  If your guest OS
751
supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
752
to use high resolution modes (>= 1280x1024x16) then you should use
753
this option.
754
@item vmware
755
VMWare SVGA-II compatible adapter. Use it if you have sufficiently
756
recent XFree86/XOrg server or Windows guest with a driver for this
757
card.
758
@item none
759
Disable VGA card.
760
@end table
761
ETEXI
762

    
763
DEF("full-screen", 0, QEMU_OPTION_full_screen,
764
    "-full-screen    start in full screen\n", QEMU_ARCH_ALL)
765
STEXI
766
@item -full-screen
767
@findex -full-screen
768
Start in full screen.
769
ETEXI
770

    
771
DEF("g", 1, QEMU_OPTION_g ,
772
    "-g WxH[xDEPTH]  Set the initial graphical resolution and depth\n",
773
    QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
774
STEXI
775
@item -g @var{width}x@var{height}[x@var{depth}]
776
@findex -g
777
Set the initial graphical resolution and depth (PPC, SPARC only).
778
ETEXI
779

    
780
DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
781
    "-vnc display    start a VNC server on display\n", QEMU_ARCH_ALL)
782
STEXI
783
@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
784
@findex -vnc
785
Normally, QEMU uses SDL to display the VGA output.  With this option,
786
you can have QEMU listen on VNC display @var{display} and redirect the VGA
787
display over the VNC session.  It is very useful to enable the usb
788
tablet device when using this option (option @option{-usbdevice
789
tablet}). When using the VNC display, you must use the @option{-k}
790
parameter to set the keyboard layout if you are not using en-us. Valid
791
syntax for the @var{display} is
792

    
793
@table @option
794

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

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

    
801
@item unix:@var{path}
802

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

    
806
@item none
807

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

    
811
@end table
812

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

    
816
@table @option
817

    
818
@item reverse
819

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

    
825
@item password
826

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

    
831
@item tls
832

    
833
Require that client use TLS when communicating with the VNC server. This
834
uses anonymous TLS credentials so is susceptible to a man-in-the-middle
835
attack. It is recommended that this option be combined with either the
836
@option{x509} or @option{x509verify} options.
837

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

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

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

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

    
860
@item sasl
861

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

    
875
@item acl
876

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

    
888
@item lossy
889

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

    
895
@end table
896
ETEXI
897

    
898
STEXI
899
@end table
900
ETEXI
901

    
902
DEFHEADING()
903

    
904
DEFHEADING(i386 target only:)
905
STEXI
906
@table @option
907
ETEXI
908

    
909
DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack,
910
    "-win2k-hack     use it when installing Windows 2000 to avoid a disk full bug\n",
911
    QEMU_ARCH_I386)
912
STEXI
913
@item -win2k-hack
914
@findex -win2k-hack
915
Use it when installing Windows 2000 to avoid a disk full bug. After
916
Windows 2000 is installed, you no longer need this option (this option
917
slows down the IDE transfers).
918
ETEXI
919

    
920
HXCOMM Deprecated by -rtc
921
DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386)
922

    
923
DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
924
    "-no-fd-bootchk  disable boot signature checking for floppy disks\n",
925
    QEMU_ARCH_I386)
926
STEXI
927
@item -no-fd-bootchk
928
@findex -no-fd-bootchk
929
Disable boot signature checking for floppy disks in Bochs BIOS. It may
930
be needed to boot from old floppy disks.
931
TODO: check reference to Bochs BIOS.
932
ETEXI
933

    
934
DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
935
           "-no-acpi        disable ACPI\n", QEMU_ARCH_I386)
936
STEXI
937
@item -no-acpi
938
@findex -no-acpi
939
Disable ACPI (Advanced Configuration and Power Interface) support. Use
940
it if your guest OS complains about ACPI problems (PC target machine
941
only).
942
ETEXI
943

    
944
DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
945
    "-no-hpet        disable HPET\n", QEMU_ARCH_I386)
946
STEXI
947
@item -no-hpet
948
@findex -no-hpet
949
Disable HPET support.
950
ETEXI
951

    
952
DEF("balloon", HAS_ARG, QEMU_OPTION_balloon,
953
    "-balloon none   disable balloon device\n"
954
    "-balloon virtio[,addr=str]\n"
955
    "                enable virtio balloon device (default)\n", QEMU_ARCH_ALL)
956
STEXI
957
@item -balloon none
958
@findex -balloon
959
Disable balloon device.
960
@item -balloon virtio[,addr=@var{addr}]
961
Enable virtio balloon device (default), optionally with PCI address
962
@var{addr}.
963
ETEXI
964

    
965
DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
966
    "-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"
967
    "                ACPI table description\n", QEMU_ARCH_I386)
968
STEXI
969
@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}]...]
970
@findex -acpitable
971
Add ACPI table with specified header fields and context from specified files.
972
ETEXI
973

    
974
DEF("smbios", HAS_ARG, QEMU_OPTION_smbios,
975
    "-smbios file=binary\n"
976
    "                load SMBIOS entry from binary file\n"
977
    "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n"
978
    "                specify SMBIOS type 0 fields\n"
979
    "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
980
    "              [,uuid=uuid][,sku=str][,family=str]\n"
981
    "                specify SMBIOS type 1 fields\n", QEMU_ARCH_I386)
982
STEXI
983
@item -smbios file=@var{binary}
984
@findex -smbios
985
Load SMBIOS entry from binary file.
986

    
987
@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}]
988
@findex -smbios
989
Specify SMBIOS type 0 fields
990

    
991
@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}]
992
Specify SMBIOS type 1 fields
993
ETEXI
994

    
995
DEFHEADING()
996
STEXI
997
@end table
998
ETEXI
999

    
1000
DEFHEADING(Network options:)
1001
STEXI
1002
@table @option
1003
ETEXI
1004

    
1005
HXCOMM Legacy slirp options (now moved to -net user):
1006
#ifdef CONFIG_SLIRP
1007
DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL)
1008
DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL)
1009
DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL)
1010
#ifndef _WIN32
1011
DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL)
1012
#endif
1013
#endif
1014

    
1015
DEF("net", HAS_ARG, QEMU_OPTION_net,
1016
    "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n"
1017
    "                create a new Network Interface Card and connect it to VLAN 'n'\n"
1018
#ifdef CONFIG_SLIRP
1019
    "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=y|n]\n"
1020
    "         [,hostname=host][,dhcpstart=addr][,dns=addr][,tftp=dir][,bootfile=f]\n"
1021
    "         [,hostfwd=rule][,guestfwd=rule]"
1022
#ifndef _WIN32
1023
                                             "[,smb=dir[,smbserver=addr]]\n"
1024
#endif
1025
    "                connect the user mode network stack to VLAN 'n', configure its\n"
1026
    "                DHCP server and enabled optional services\n"
1027
#endif
1028
#ifdef _WIN32
1029
    "-net tap[,vlan=n][,name=str],ifname=name\n"
1030
    "                connect the host TAP network interface to VLAN 'n'\n"
1031
#else
1032
    "-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]\n"
1033
    "                connect the host TAP network interface to VLAN 'n' and use the\n"
1034
    "                network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n"
1035
    "                and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n"
1036
    "                use '[down]script=no' to disable script execution\n"
1037
    "                use 'fd=h' to connect to an already opened TAP interface\n"
1038
    "                use 'sndbuf=nbytes' to limit the size of the send buffer (the\n"
1039
    "                default of 'sndbuf=1048576' can be disabled using 'sndbuf=0')\n"
1040
    "                use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n"
1041
    "                use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n"
1042
    "                use vhost=on to enable experimental in kernel accelerator\n"
1043
    "                use 'vhostfd=h' to connect to an already opened vhost net device\n"
1044
#endif
1045
    "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n"
1046
    "                connect the vlan 'n' to another VLAN using a socket connection\n"
1047
    "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port]\n"
1048
    "                connect the vlan 'n' to multicast maddr and port\n"
1049
#ifdef CONFIG_VDE
1050
    "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n"
1051
    "                connect the vlan 'n' to port 'n' of a vde switch running\n"
1052
    "                on host and listening for incoming connections on 'socketpath'.\n"
1053
    "                Use group 'groupname' and mode 'octalmode' to change default\n"
1054
    "                ownership and permissions for communication port.\n"
1055
#endif
1056
    "-net dump[,vlan=n][,file=f][,len=n]\n"
1057
    "                dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n"
1058
    "-net none       use it alone to have zero network devices. If no -net option\n"
1059
    "                is provided, the default is '-net nic -net user'\n", QEMU_ARCH_ALL)
1060
DEF("netdev", HAS_ARG, QEMU_OPTION_netdev,
1061
    "-netdev ["
1062
#ifdef CONFIG_SLIRP
1063
    "user|"
1064
#endif
1065
    "tap|"
1066
#ifdef CONFIG_VDE
1067
    "vde|"
1068
#endif
1069
    "socket],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL)
1070
STEXI
1071
@item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
1072
@findex -net
1073
Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
1074
= 0 is the default). The NIC is an e1000 by default on the PC
1075
target. Optionally, the MAC address can be changed to @var{mac}, the
1076
device address set to @var{addr} (PCI cards only),
1077
and a @var{name} can be assigned for use in monitor commands.
1078
Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
1079
that the card should have; this option currently only affects virtio cards; set
1080
@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
1081
NIC is created.  Qemu can emulate several different models of network card.
1082
Valid values for @var{type} are
1083
@code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
1084
@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
1085
@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
1086
Not all devices are supported on all targets.  Use -net nic,model=?
1087
for a list of available devices for your target.
1088

    
1089
@item -net user[,@var{option}][,@var{option}][,...]
1090
Use the user mode network stack which requires no administrator
1091
privilege to run. Valid options are:
1092

    
1093
@table @option
1094
@item vlan=@var{n}
1095
Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
1096

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

    
1100
@item net=@var{addr}[/@var{mask}]
1101
Set IP network address the guest will see. Optionally specify the netmask,
1102
either in the form a.b.c.d or as number of valid top-most bits. Default is
1103
10.0.2.0/8.
1104

    
1105
@item host=@var{addr}
1106
Specify the guest-visible address of the host. Default is the 2nd IP in the
1107
guest network, i.e. x.x.x.2.
1108

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

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

    
1117
@item dhcpstart=@var{addr}
1118
Specify the first of the 16 IPs the built-in DHCP server can assign. Default
1119
is the 16th to 31st IP in the guest network, i.e. x.x.x.16 to x.x.x.31.
1120

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

    
1126
@item tftp=@var{dir}
1127
When using the user mode network stack, activate a built-in TFTP
1128
server. The files in @var{dir} will be exposed as the root of a TFTP server.
1129
The TFTP client on the guest must be configured in binary mode (use the command
1130
@code{bin} of the Unix TFTP client).
1131

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

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

    
1142
@item smb=@var{dir}[,smbserver=@var{addr}]
1143
When using the user mode network stack, activate a built-in SMB
1144
server so that Windows OSes can access to the host files in @file{@var{dir}}
1145
transparently. The IP address of the SMB server can be set to @var{addr}. By
1146
default the 4th IP in the guest network is used, i.e. x.x.x.4.
1147

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

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

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

    
1161
@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
1162
Redirect incoming TCP or UDP connections to the host port @var{hostport} to
1163
the guest IP address @var{guestaddr} on guest port @var{guestport}. If
1164
@var{guestaddr} is not specified, its value is x.x.x.15 (default first address
1165
given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
1166
be bound to a specific host interface. If no connection type is set, TCP is
1167
used. This option can be given multiple times.
1168

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

    
1172
@example
1173
# on the host
1174
qemu -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
1175
# this host xterm should open in the guest X11 server
1176
xterm -display :1
1177
@end example
1178

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

    
1182
@example
1183
# on the host
1184
qemu -net user,hostfwd=tcp::5555-:23 [...]
1185
telnet localhost 5555
1186
@end example
1187

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

    
1191
@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
1192
Forward guest TCP connections to the IP address @var{server} on port @var{port}
1193
to the character device @var{dev}. This option can be given multiple times.
1194

    
1195
@end table
1196

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

    
1202
@item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}] [,script=@var{file}][,downscript=@var{dfile}]
1203
Connect the host TAP network interface @var{name} to VLAN @var{n}, use
1204
the network script @var{file} to configure it and the network script
1205
@var{dfile} to deconfigure it. If @var{name} is not provided, the OS
1206
automatically provides one. @option{fd}=@var{h} can be used to specify
1207
the handle of an already opened host TAP interface. The default network
1208
configure script is @file{/etc/qemu-ifup} and the default network
1209
deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no}
1210
or @option{downscript=no} to disable script execution. Example:
1211

    
1212
@example
1213
qemu linux.img -net nic -net tap
1214
@end example
1215

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

    
1222
@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
1223

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

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

    
1242
@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,mcast=@var{maddr}:@var{port}]
1243

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

    
1259
Example:
1260
@example
1261
# launch one QEMU instance
1262
qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1263
               -net socket,mcast=230.0.0.1:1234
1264
# launch another QEMU instance on same "bus"
1265
qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1266
               -net socket,mcast=230.0.0.1:1234
1267
# launch yet another QEMU instance on same "bus"
1268
qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
1269
               -net socket,mcast=230.0.0.1:1234
1270
@end example
1271

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

    
1282
@item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
1283
Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
1284
listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
1285
and MODE @var{octalmode} to change default ownership and permissions for
1286
communication port. This option is available only if QEMU has been compiled
1287
with vde support enabled.
1288

    
1289
Example:
1290
@example
1291
# launch vde switch
1292
vde_switch -F -sock /tmp/myswitch
1293
# launch QEMU instance
1294
qemu linux.img -net nic -net vde,sock=/tmp/myswitch
1295
@end example
1296

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

    
1302
@item -net none
1303
Indicate that no network devices should be configured. It is used to
1304
override the default configuration (@option{-net nic -net user}) which
1305
is activated if no @option{-net} options are provided.
1306

    
1307
@end table
1308
ETEXI
1309

    
1310
DEFHEADING()
1311

    
1312
DEFHEADING(Character device options:)
1313

    
1314
DEF("chardev", HAS_ARG, QEMU_OPTION_chardev,
1315
    "-chardev null,id=id[,mux=on|off]\n"
1316
    "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n"
1317
    "         [,server][,nowait][,telnet][,mux=on|off] (tcp)\n"
1318
    "-chardev socket,id=id,path=path[,server][,nowait][,telnet],[mux=on|off] (unix)\n"
1319
    "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n"
1320
    "         [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n"
1321
    "-chardev msmouse,id=id[,mux=on|off]\n"
1322
    "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n"
1323
    "         [,mux=on|off]\n"
1324
    "-chardev file,id=id,path=path[,mux=on|off]\n"
1325
    "-chardev pipe,id=id,path=path[,mux=on|off]\n"
1326
#ifdef _WIN32
1327
    "-chardev console,id=id[,mux=on|off]\n"
1328
    "-chardev serial,id=id,path=path[,mux=on|off]\n"
1329
#else
1330
    "-chardev pty,id=id[,mux=on|off]\n"
1331
    "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n"
1332
#endif
1333
#ifdef CONFIG_BRLAPI
1334
    "-chardev braille,id=id[,mux=on|off]\n"
1335
#endif
1336
#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1337
        || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
1338
    "-chardev tty,id=id,path=path[,mux=on|off]\n"
1339
#endif
1340
#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__)
1341
    "-chardev parport,id=id,path=path[,mux=on|off]\n"
1342
#endif
1343
    , QEMU_ARCH_ALL
1344
)
1345

    
1346
STEXI
1347

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

    
1351
@item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}]
1352
@findex -chardev
1353
Backend is one of:
1354
@option{null},
1355
@option{socket},
1356
@option{udp},
1357
@option{msmouse},
1358
@option{vc},
1359
@option{file},
1360
@option{pipe},
1361
@option{console},
1362
@option{serial},
1363
@option{pty},
1364
@option{stdio},
1365
@option{braille},
1366
@option{tty},
1367
@option{parport}.
1368
The specific backend will determine the applicable options.
1369

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

    
1373
A character device may be used in multiplexing mode by multiple front-ends.
1374
The key sequence of @key{Control-a} and @key{c} will rotate the input focus
1375
between attached front-ends. Specify @option{mux=on} to enable this mode.
1376

    
1377
Options to each backend are described below.
1378

    
1379
@item -chardev null ,id=@var{id}
1380
A void device. This device will not emit any data, and will drop any data it
1381
receives. The null backend does not take any options.
1382

    
1383
@item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet]
1384

    
1385
Create a two-way stream socket, which can be either a TCP or a unix socket. A
1386
unix socket will be created if @option{path} is specified. Behaviour is
1387
undefined if TCP options are specified for a unix socket.
1388

    
1389
@option{server} specifies that the socket shall be a listening socket.
1390

    
1391
@option{nowait} specifies that QEMU should not block waiting for a client to
1392
connect to a listening socket.
1393

    
1394
@option{telnet} specifies that traffic on the socket should interpret telnet
1395
escape sequences.
1396

    
1397
TCP and unix socket options are given below:
1398

    
1399
@table @option
1400

    
1401
@item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay]
1402

    
1403
@option{host} for a listening socket specifies the local address to be bound.
1404
For a connecting socket species the remote host to connect to. @option{host} is
1405
optional for listening sockets. If not specified it defaults to @code{0.0.0.0}.
1406

    
1407
@option{port} for a listening socket specifies the local port to be bound. For a
1408
connecting socket specifies the port on the remote host to connect to.
1409
@option{port} can be given as either a port number or a service name.
1410
@option{port} is required.
1411

    
1412
@option{to} is only relevant to listening sockets. If it is specified, and
1413
@option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up
1414
to and including @option{to} until it succeeds. @option{to} must be specified
1415
as a port number.
1416

    
1417
@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1418
If neither is specified the socket may use either protocol.
1419

    
1420
@option{nodelay} disables the Nagle algorithm.
1421

    
1422
@item unix options: path=@var{path}
1423

    
1424
@option{path} specifies the local path of the unix socket. @option{path} is
1425
required.
1426

    
1427
@end table
1428

    
1429
@item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6]
1430

    
1431
Sends all traffic from the guest to a remote host over UDP.
1432

    
1433
@option{host} specifies the remote host to connect to. If not specified it
1434
defaults to @code{localhost}.
1435

    
1436
@option{port} specifies the port on the remote host to connect to. @option{port}
1437
is required.
1438

    
1439
@option{localaddr} specifies the local address to bind to. If not specified it
1440
defaults to @code{0.0.0.0}.
1441

    
1442
@option{localport} specifies the local port to bind to. If not specified any
1443
available local port will be used.
1444

    
1445
@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1446
If neither is specified the device may use either protocol.
1447

    
1448
@item -chardev msmouse ,id=@var{id}
1449

    
1450
Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not
1451
take any options.
1452

    
1453
@item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]]
1454

    
1455
Connect to a QEMU text console. @option{vc} may optionally be given a specific
1456
size.
1457

    
1458
@option{width} and @option{height} specify the width and height respectively of
1459
the console, in pixels.
1460

    
1461
@option{cols} and @option{rows} specify that the console be sized to fit a text
1462
console with the given dimensions.
1463

    
1464
@item -chardev file ,id=@var{id} ,path=@var{path}
1465

    
1466
Log all traffic received from the guest to a file.
1467

    
1468
@option{path} specifies the path of the file to be opened. This file will be
1469
created if it does not already exist, and overwritten if it does. @option{path}
1470
is required.
1471

    
1472
@item -chardev pipe ,id=@var{id} ,path=@var{path}
1473

    
1474
Create a two-way connection to the guest. The behaviour differs slightly between
1475
Windows hosts and other hosts:
1476

    
1477
On Windows, a single duplex pipe will be created at
1478
@file{\\.pipe\@option{path}}.
1479

    
1480
On other hosts, 2 pipes will be created called @file{@option{path}.in} and
1481
@file{@option{path}.out}. Data written to @file{@option{path}.in} will be
1482
received by the guest. Data written by the guest can be read from
1483
@file{@option{path}.out}. QEMU will not create these fifos, and requires them to
1484
be present.
1485

    
1486
@option{path} forms part of the pipe path as described above. @option{path} is
1487
required.
1488

    
1489
@item -chardev console ,id=@var{id}
1490

    
1491
Send traffic from the guest to QEMU's standard output. @option{console} does not
1492
take any options.
1493

    
1494
@option{console} is only available on Windows hosts.
1495

    
1496
@item -chardev serial ,id=@var{id} ,path=@option{path}
1497

    
1498
Send traffic from the guest to a serial device on the host.
1499

    
1500
@option{serial} is
1501
only available on Windows hosts.
1502

    
1503
@option{path} specifies the name of the serial device to open.
1504

    
1505
@item -chardev pty ,id=@var{id}
1506

    
1507
Create a new pseudo-terminal on the host and connect to it. @option{pty} does
1508
not take any options.
1509

    
1510
@option{pty} is not available on Windows hosts.
1511

    
1512
@item -chardev stdio ,id=@var{id} [,signal=on|off]
1513
Connect to standard input and standard output of the qemu process.
1514

    
1515
@option{signal} controls if signals are enabled on the terminal, that includes
1516
exiting QEMU with the key sequence @key{Control-c}. This option is enabled by
1517
default, use @option{signal=off} to disable it.
1518

    
1519
@option{stdio} is not available on Windows hosts.
1520

    
1521
@item -chardev braille ,id=@var{id}
1522

    
1523
Connect to a local BrlAPI server. @option{braille} does not take any options.
1524

    
1525
@item -chardev tty ,id=@var{id} ,path=@var{path}
1526

    
1527
Connect to a local tty device.
1528

    
1529
@option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and
1530
DragonFlyBSD hosts.
1531

    
1532
@option{path} specifies the path to the tty. @option{path} is required.
1533

    
1534
@item -chardev parport ,id=@var{id} ,path=@var{path}
1535

    
1536
@option{parport} is only available on Linux, FreeBSD and DragonFlyBSD hosts.
1537

    
1538
Connect to a local parallel port.
1539

    
1540
@option{path} specifies the path to the parallel port device. @option{path} is
1541
required.
1542

    
1543
@end table
1544
ETEXI
1545

    
1546
DEFHEADING()
1547

    
1548
DEFHEADING(Bluetooth(R) options:)
1549

    
1550
DEF("bt", HAS_ARG, QEMU_OPTION_bt, \
1551
    "-bt hci,null    dumb bluetooth HCI - doesn't respond to commands\n" \
1552
    "-bt hci,host[:id]\n" \
1553
    "                use host's HCI with the given name\n" \
1554
    "-bt hci[,vlan=n]\n" \
1555
    "                emulate a standard HCI in virtual scatternet 'n'\n" \
1556
    "-bt vhci[,vlan=n]\n" \
1557
    "                add host computer to virtual scatternet 'n' using VHCI\n" \
1558
    "-bt device:dev[,vlan=n]\n" \
1559
    "                emulate a bluetooth device 'dev' in scatternet 'n'\n",
1560
    QEMU_ARCH_ALL)
1561
STEXI
1562
@table @option
1563

    
1564
@item -bt hci[...]
1565
@findex -bt
1566
Defines the function of the corresponding Bluetooth HCI.  -bt options
1567
are matched with the HCIs present in the chosen machine type.  For
1568
example when emulating a machine with only one HCI built into it, only
1569
the first @code{-bt hci[...]} option is valid and defines the HCI's
1570
logic.  The Transport Layer is decided by the machine type.  Currently
1571
the machines @code{n800} and @code{n810} have one HCI and all other
1572
machines have none.
1573

    
1574
@anchor{bt-hcis}
1575
The following three types are recognized:
1576

    
1577
@table @option
1578
@item -bt hci,null
1579
(default) The corresponding Bluetooth HCI assumes no internal logic
1580
and will not respond to any HCI commands or emit events.
1581

    
1582
@item -bt hci,host[:@var{id}]
1583
(@code{bluez} only) The corresponding HCI passes commands / events
1584
to / from the physical HCI identified by the name @var{id} (default:
1585
@code{hci0}) on the computer running QEMU.  Only available on @code{bluez}
1586
capable systems like Linux.
1587

    
1588
@item -bt hci[,vlan=@var{n}]
1589
Add a virtual, standard HCI that will participate in the Bluetooth
1590
scatternet @var{n} (default @code{0}).  Similarly to @option{-net}
1591
VLANs, devices inside a bluetooth network @var{n} can only communicate
1592
with other devices in the same network (scatternet).
1593
@end table
1594

    
1595
@item -bt vhci[,vlan=@var{n}]
1596
(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
1597
to the host bluetooth stack instead of to the emulated target.  This
1598
allows the host and target machines to participate in a common scatternet
1599
and communicate.  Requires the Linux @code{vhci} driver installed.  Can
1600
be used as following:
1601

    
1602
@example
1603
qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
1604
@end example
1605

    
1606
@item -bt device:@var{dev}[,vlan=@var{n}]
1607
Emulate a bluetooth device @var{dev} and place it in network @var{n}
1608
(default @code{0}).  QEMU can only emulate one type of bluetooth devices
1609
currently:
1610

    
1611
@table @option
1612
@item keyboard
1613
Virtual wireless keyboard implementing the HIDP bluetooth profile.
1614
@end table
1615
@end table
1616
ETEXI
1617

    
1618
DEFHEADING()
1619

    
1620
DEFHEADING(Linux/Multiboot boot specific:)
1621
STEXI
1622

    
1623
When using these options, you can use a given Linux or Multiboot
1624
kernel without installing it in the disk image. It can be useful
1625
for easier testing of various kernels.
1626

    
1627
@table @option
1628
ETEXI
1629

    
1630
DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \
1631
    "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL)
1632
STEXI
1633
@item -kernel @var{bzImage}
1634
@findex -kernel
1635
Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
1636
or in multiboot format.
1637
ETEXI
1638

    
1639
DEF("append", HAS_ARG, QEMU_OPTION_append, \
1640
    "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL)
1641
STEXI
1642
@item -append @var{cmdline}
1643
@findex -append
1644
Use @var{cmdline} as kernel command line
1645
ETEXI
1646

    
1647
DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \
1648
           "-initrd file    use 'file' as initial ram disk\n", QEMU_ARCH_ALL)
1649
STEXI
1650
@item -initrd @var{file}
1651
@findex -initrd
1652
Use @var{file} as initial ram disk.
1653

    
1654
@item -initrd "@var{file1} arg=foo,@var{file2}"
1655

    
1656
This syntax is only available with multiboot.
1657

    
1658
Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
1659
first module.
1660
ETEXI
1661

    
1662
STEXI
1663
@end table
1664
ETEXI
1665

    
1666
DEFHEADING()
1667

    
1668
DEFHEADING(Debug/Expert options:)
1669

    
1670
STEXI
1671
@table @option
1672
ETEXI
1673

    
1674
DEF("serial", HAS_ARG, QEMU_OPTION_serial, \
1675
    "-serial dev     redirect the serial port to char device 'dev'\n",
1676
    QEMU_ARCH_ALL)
1677
STEXI
1678
@item -serial @var{dev}
1679
@findex -serial
1680
Redirect the virtual serial port to host character device
1681
@var{dev}. The default device is @code{vc} in graphical mode and
1682
@code{stdio} in non graphical mode.
1683

    
1684
This option can be used several times to simulate up to 4 serial
1685
ports.
1686

    
1687
Use @code{-serial none} to disable all serial ports.
1688

    
1689
Available character devices are:
1690
@table @option
1691
@item vc[:@var{W}x@var{H}]
1692
Virtual console. Optionally, a width and height can be given in pixel with
1693
@example
1694
vc:800x600
1695
@end example
1696
It is also possible to specify width or height in characters:
1697
@example
1698
vc:80Cx24C
1699
@end example
1700
@item pty
1701
[Linux only] Pseudo TTY (a new PTY is automatically allocated)
1702
@item none
1703
No device is allocated.
1704
@item null
1705
void device
1706
@item /dev/XXX
1707
[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
1708
parameters are set according to the emulated ones.
1709
@item /dev/parport@var{N}
1710
[Linux only, parallel port only] Use host parallel port
1711
@var{N}. Currently SPP and EPP parallel port features can be used.
1712
@item file:@var{filename}
1713
Write output to @var{filename}. No character can be read.
1714
@item stdio
1715
[Unix only] standard input/output
1716
@item pipe:@var{filename}
1717
name pipe @var{filename}
1718
@item COM@var{n}
1719
[Windows only] Use host serial port @var{n}
1720
@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
1721
This implements UDP Net Console.
1722
When @var{remote_host} or @var{src_ip} are not specified
1723
they default to @code{0.0.0.0}.
1724
When not using a specified @var{src_port} a random port is automatically chosen.
1725

    
1726
If you just want a simple readonly console you can use @code{netcat} or
1727
@code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
1728
@code{nc -u -l -p 4555}. Any time qemu writes something to that port it
1729
will appear in the netconsole session.
1730

    
1731
If you plan to send characters back via netconsole or you want to stop
1732
and start qemu a lot of times, you should have qemu use the same
1733
source port each time by using something like @code{-serial
1734
udp::4555@@:4556} to qemu. Another approach is to use a patched
1735
version of netcat which can listen to a TCP port and send and receive
1736
characters via udp.  If you have a patched version of netcat which
1737
activates telnet remote echo and single char transfer, then you can
1738
use the following options to step up a netcat redirector to allow
1739
telnet on port 5555 to access the qemu port.
1740
@table @code
1741
@item Qemu Options:
1742
-serial udp::4555@@:4556
1743
@item netcat options:
1744
-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
1745
@item telnet options:
1746
localhost 5555
1747
@end table
1748

    
1749
@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
1750
The TCP Net Console has two modes of operation.  It can send the serial
1751
I/O to a location or wait for a connection from a location.  By default
1752
the TCP Net Console is sent to @var{host} at the @var{port}.  If you use
1753
the @var{server} option QEMU will wait for a client socket application
1754
to connect to the port before continuing, unless the @code{nowait}
1755
option was specified.  The @code{nodelay} option disables the Nagle buffering
1756
algorithm.  If @var{host} is omitted, 0.0.0.0 is assumed. Only
1757
one TCP connection at a time is accepted. You can use @code{telnet} to
1758
connect to the corresponding character device.
1759
@table @code
1760
@item Example to send tcp console to 192.168.0.2 port 4444
1761
-serial tcp:192.168.0.2:4444
1762
@item Example to listen and wait on port 4444 for connection
1763
-serial tcp::4444,server
1764
@item Example to not wait and listen on ip 192.168.0.100 port 4444
1765
-serial tcp:192.168.0.100:4444,server,nowait
1766
@end table
1767

    
1768
@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
1769
The telnet protocol is used instead of raw tcp sockets.  The options
1770
work the same as if you had specified @code{-serial tcp}.  The
1771
difference is that the port acts like a telnet server or client using
1772
telnet option negotiation.  This will also allow you to send the
1773
MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
1774
sequence.  Typically in unix telnet you do it with Control-] and then
1775
type "send break" followed by pressing the enter key.
1776

    
1777
@item unix:@var{path}[,server][,nowait]
1778
A unix domain socket is used instead of a tcp socket.  The option works the
1779
same as if you had specified @code{-serial tcp} except the unix domain socket
1780
@var{path} is used for connections.
1781

    
1782
@item mon:@var{dev_string}
1783
This is a special option to allow the monitor to be multiplexed onto
1784
another serial port.  The monitor is accessed with key sequence of
1785
@key{Control-a} and then pressing @key{c}. See monitor access
1786
@ref{pcsys_keys} in the -nographic section for more keys.
1787
@var{dev_string} should be any one of the serial devices specified
1788
above.  An example to multiplex the monitor onto a telnet server
1789
listening on port 4444 would be:
1790
@table @code
1791
@item -serial mon:telnet::4444,server,nowait
1792
@end table
1793

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

    
1798
@item msmouse
1799
Three button serial mouse. Configure the guest to use Microsoft protocol.
1800
@end table
1801
ETEXI
1802

    
1803
DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \
1804
    "-parallel dev   redirect the parallel port to char device 'dev'\n",
1805
    QEMU_ARCH_ALL)
1806
STEXI
1807
@item -parallel @var{dev}
1808
@findex -parallel
1809
Redirect the virtual parallel port to host device @var{dev} (same
1810
devices as the serial port). On Linux hosts, @file{/dev/parportN} can
1811
be used to use hardware devices connected on the corresponding host
1812
parallel port.
1813

    
1814
This option can be used several times to simulate up to 3 parallel
1815
ports.
1816

    
1817
Use @code{-parallel none} to disable all parallel ports.
1818
ETEXI
1819

    
1820
DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \
1821
    "-monitor dev    redirect the monitor to char device 'dev'\n",
1822
    QEMU_ARCH_ALL)
1823
STEXI
1824
@item -monitor @var{dev}
1825
@findex -monitor
1826
Redirect the monitor to host device @var{dev} (same devices as the
1827
serial port).
1828
The default device is @code{vc} in graphical mode and @code{stdio} in
1829
non graphical mode.
1830
ETEXI
1831
DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \
1832
    "-qmp dev        like -monitor but opens in 'control' mode\n",
1833
    QEMU_ARCH_ALL)
1834
STEXI
1835
@item -qmp @var{dev}
1836
@findex -qmp
1837
Like -monitor but opens in 'control' mode.
1838
ETEXI
1839

    
1840
DEF("mon", HAS_ARG, QEMU_OPTION_mon, \
1841
    "-mon chardev=[name][,mode=readline|control][,default]\n", QEMU_ARCH_ALL)
1842
STEXI
1843
@item -mon chardev=[name][,mode=readline|control][,default]
1844
@findex -mon
1845
Setup monitor on chardev @var{name}.
1846
ETEXI
1847

    
1848
DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \
1849
    "-debugcon dev   redirect the debug console to char device 'dev'\n",
1850
    QEMU_ARCH_ALL)
1851
STEXI
1852
@item -debugcon @var{dev}
1853
@findex -debugcon
1854
Redirect the debug console to host device @var{dev} (same devices as the
1855
serial port).  The debug console is an I/O port which is typically port
1856
0xe9; writing to that I/O port sends output to this device.
1857
The default device is @code{vc} in graphical mode and @code{stdio} in
1858
non graphical mode.
1859
ETEXI
1860

    
1861
DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \
1862
    "-pidfile file   write PID to 'file'\n", QEMU_ARCH_ALL)
1863
STEXI
1864
@item -pidfile @var{file}
1865
@findex -pidfile
1866
Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
1867
from a script.
1868
ETEXI
1869

    
1870
DEF("singlestep", 0, QEMU_OPTION_singlestep, \
1871
    "-singlestep     always run in singlestep mode\n", QEMU_ARCH_ALL)
1872
STEXI
1873
@item -singlestep
1874
@findex -singlestep
1875
Run the emulation in single step mode.
1876
ETEXI
1877

    
1878
DEF("S", 0, QEMU_OPTION_S, \
1879
    "-S              freeze CPU at startup (use 'c' to start execution)\n",
1880
    QEMU_ARCH_ALL)
1881
STEXI
1882
@item -S
1883
@findex -S
1884
Do not start CPU at startup (you must type 'c' in the monitor).
1885
ETEXI
1886

    
1887
DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \
1888
    "-gdb dev        wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL)
1889
STEXI
1890
@item -gdb @var{dev}
1891
@findex -gdb
1892
Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
1893
connections will likely be TCP-based, but also UDP, pseudo TTY, or even
1894
stdio are reasonable use case. The latter is allowing to start qemu from
1895
within gdb and establish the connection via a pipe:
1896
@example
1897
(gdb) target remote | exec qemu -gdb stdio ...
1898
@end example
1899
ETEXI
1900

    
1901
DEF("s", 0, QEMU_OPTION_s, \
1902
    "-s              shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n",
1903
    QEMU_ARCH_ALL)
1904
STEXI
1905
@item -s
1906
@findex -s
1907
Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
1908
(@pxref{gdb_usage}).
1909
ETEXI
1910

    
1911
DEF("d", HAS_ARG, QEMU_OPTION_d, \
1912
    "-d item1,...    output log to /tmp/qemu.log (use -d ? for a list of log items)\n",
1913
    QEMU_ARCH_ALL)
1914
STEXI
1915
@item -d
1916
@findex -d
1917
Output log in /tmp/qemu.log
1918
ETEXI
1919

    
1920
DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \
1921
    "-hdachs c,h,s[,t]\n" \
1922
    "                force hard disk 0 physical geometry and the optional BIOS\n" \
1923
    "                translation (t=none or lba) (usually qemu can guess them)\n",
1924
    QEMU_ARCH_ALL)
1925
STEXI
1926
@item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
1927
@findex -hdachs
1928
Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
1929
@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
1930
translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
1931
all those parameters. This option is useful for old MS-DOS disk
1932
images.
1933
ETEXI
1934

    
1935
DEF("L", HAS_ARG, QEMU_OPTION_L, \
1936
    "-L path         set the directory for the BIOS, VGA BIOS and keymaps\n",
1937
    QEMU_ARCH_ALL)
1938
STEXI
1939
@item -L  @var{path}
1940
@findex -L
1941
Set the directory for the BIOS, VGA BIOS and keymaps.
1942
ETEXI
1943

    
1944
DEF("bios", HAS_ARG, QEMU_OPTION_bios, \
1945
    "-bios file      set the filename for the BIOS\n", QEMU_ARCH_ALL)
1946
STEXI
1947
@item -bios @var{file}
1948
@findex -bios
1949
Set the filename for the BIOS.
1950
ETEXI
1951

    
1952
DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \
1953
    "-enable-kvm     enable KVM full virtualization support\n", QEMU_ARCH_ALL)
1954
STEXI
1955
@item -enable-kvm
1956
@findex -enable-kvm
1957
Enable KVM full virtualization support. This option is only available
1958
if KVM support is enabled when compiling.
1959
ETEXI
1960

    
1961
DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid,
1962
    "-xen-domid id   specify xen guest domain id\n", QEMU_ARCH_ALL)
1963
DEF("xen-create", 0, QEMU_OPTION_xen_create,
1964
    "-xen-create     create domain using xen hypercalls, bypassing xend\n"
1965
    "                warning: should not be used when xend is in use\n",
1966
    QEMU_ARCH_ALL)
1967
DEF("xen-attach", 0, QEMU_OPTION_xen_attach,
1968
    "-xen-attach     attach to existing xen domain\n"
1969
    "                xend will use this when starting qemu\n",
1970
    QEMU_ARCH_ALL)
1971
STEXI
1972
@item -xen-domid @var{id}
1973
@findex -xen-domid
1974
Specify xen guest domain @var{id} (XEN only).
1975
@item -xen-create
1976
@findex -xen-create
1977
Create domain using xen hypercalls, bypassing xend.
1978
Warning: should not be used when xend is in use (XEN only).
1979
@item -xen-attach
1980
@findex -xen-attach
1981
Attach to existing xen domain.
1982
xend will use this when starting qemu (XEN only).
1983
ETEXI
1984

    
1985
DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \
1986
    "-no-reboot      exit instead of rebooting\n", QEMU_ARCH_ALL)
1987
STEXI
1988
@item -no-reboot
1989
@findex -no-reboot
1990
Exit instead of rebooting.
1991
ETEXI
1992

    
1993
DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \
1994
    "-no-shutdown    stop before shutdown\n", QEMU_ARCH_ALL)
1995
STEXI
1996
@item -no-shutdown
1997
@findex -no-shutdown
1998
Don't exit QEMU on guest shutdown, but instead only stop the emulation.
1999
This allows for instance switching to monitor to commit changes to the
2000
disk image.
2001
ETEXI
2002

    
2003
DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \
2004
    "-loadvm [tag|id]\n" \
2005
    "                start right away with a saved state (loadvm in monitor)\n",
2006
    QEMU_ARCH_ALL)
2007
STEXI
2008
@item -loadvm @var{file}
2009
@findex -loadvm
2010
Start right away with a saved state (@code{loadvm} in monitor)
2011
ETEXI
2012

    
2013
#ifndef _WIN32
2014
DEF("daemonize", 0, QEMU_OPTION_daemonize, \
2015
    "-daemonize      daemonize QEMU after initializing\n", QEMU_ARCH_ALL)
2016
#endif
2017
STEXI
2018
@item -daemonize
2019
@findex -daemonize
2020
Daemonize the QEMU process after initialization.  QEMU will not detach from
2021
standard IO until it is ready to receive connections on any of its devices.
2022
This option is a useful way for external programs to launch QEMU without having
2023
to cope with initialization race conditions.
2024
ETEXI
2025

    
2026
DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \
2027
    "-option-rom rom load a file, rom, into the option ROM space\n",
2028
    QEMU_ARCH_ALL)
2029
STEXI
2030
@item -option-rom @var{file}
2031
@findex -option-rom
2032
Load the contents of @var{file} as an option ROM.
2033
This option is useful to load things like EtherBoot.
2034
ETEXI
2035

    
2036
DEF("clock", HAS_ARG, QEMU_OPTION_clock, \
2037
    "-clock          force the use of the given methods for timer alarm.\n" \
2038
    "                To see what timers are available use -clock ?\n",
2039
    QEMU_ARCH_ALL)
2040
STEXI
2041
@item -clock @var{method}
2042
@findex -clock
2043
Force the use of the given methods for timer alarm. To see what timers
2044
are available use -clock ?.
2045
ETEXI
2046

    
2047
HXCOMM Options deprecated by -rtc
2048
DEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL)
2049
DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL)
2050

    
2051
DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \
2052
    "-rtc [base=utc|localtime|date][,clock=host|vm][,driftfix=none|slew]\n" \
2053
    "                set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n",
2054
    QEMU_ARCH_ALL)
2055

    
2056
STEXI
2057

    
2058
@item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew]
2059
@findex -rtc
2060
Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current
2061
UTC or local time, respectively. @code{localtime} is required for correct date in
2062
MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the
2063
format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC.
2064

    
2065
By default the RTC is driven by the host system time. This allows to use the
2066
RTC as accurate reference clock inside the guest, specifically if the host
2067
time is smoothly following an accurate external reference clock, e.g. via NTP.
2068
If you want to isolate the guest time from the host, even prevent it from
2069
progressing during suspension, you can set @option{clock} to @code{vm} instead.
2070

    
2071
Enable @option{driftfix} (i386 targets only) if you experience time drift problems,
2072
specifically with Windows' ACPI HAL. This option will try to figure out how
2073
many timer interrupts were not processed by the Windows guest and will
2074
re-inject them.
2075
ETEXI
2076

    
2077
DEF("icount", HAS_ARG, QEMU_OPTION_icount, \
2078
    "-icount [N|auto]\n" \
2079
    "                enable virtual instruction counter with 2^N clock ticks per\n" \
2080
    "                instruction\n", QEMU_ARCH_ALL)
2081
STEXI
2082
@item -icount [@var{N}|auto]
2083
@findex -icount
2084
Enable virtual instruction counter.  The virtual cpu will execute one
2085
instruction every 2^@var{N} ns of virtual time.  If @code{auto} is specified
2086
then the virtual cpu speed will be automatically adjusted to keep virtual
2087
time within a few seconds of real time.
2088

    
2089
Note that while this option can give deterministic behavior, it does not
2090
provide cycle accurate emulation.  Modern CPUs contain superscalar out of
2091
order cores with complex cache hierarchies.  The number of instructions
2092
executed often has little or no correlation with actual performance.
2093
ETEXI
2094

    
2095
DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \
2096
    "-watchdog i6300esb|ib700\n" \
2097
    "                enable virtual hardware watchdog [default=none]\n",
2098
    QEMU_ARCH_ALL)
2099
STEXI
2100
@item -watchdog @var{model}
2101
@findex -watchdog
2102
Create a virtual hardware watchdog device.  Once enabled (by a guest
2103
action), the watchdog must be periodically polled by an agent inside
2104
the guest or else the guest will be restarted.
2105

    
2106
The @var{model} is the model of hardware watchdog to emulate.  Choices
2107
for model are: @code{ib700} (iBASE 700) which is a very simple ISA
2108
watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O
2109
controller hub) which is a much more featureful PCI-based dual-timer
2110
watchdog.  Choose a model for which your guest has drivers.
2111

    
2112
Use @code{-watchdog ?} to list available hardware models.  Only one
2113
watchdog can be enabled for a guest.
2114
ETEXI
2115

    
2116
DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \
2117
    "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \
2118
    "                action when watchdog fires [default=reset]\n",
2119
    QEMU_ARCH_ALL)
2120
STEXI
2121
@item -watchdog-action @var{action}
2122

    
2123
The @var{action} controls what QEMU will do when the watchdog timer
2124
expires.
2125
The default is
2126
@code{reset} (forcefully reset the guest).
2127
Other possible actions are:
2128
@code{shutdown} (attempt to gracefully shutdown the guest),
2129
@code{poweroff} (forcefully poweroff the guest),
2130
@code{pause} (pause the guest),
2131
@code{debug} (print a debug message and continue), or
2132
@code{none} (do nothing).
2133

    
2134
Note that the @code{shutdown} action requires that the guest responds
2135
to ACPI signals, which it may not be able to do in the sort of
2136
situations where the watchdog would have expired, and thus
2137
@code{-watchdog-action shutdown} is not recommended for production use.
2138

    
2139
Examples:
2140

    
2141
@table @code
2142
@item -watchdog i6300esb -watchdog-action pause
2143
@item -watchdog ib700
2144
@end table
2145
ETEXI
2146

    
2147
DEF("echr", HAS_ARG, QEMU_OPTION_echr, \
2148
    "-echr chr       set terminal escape character instead of ctrl-a\n",
2149
    QEMU_ARCH_ALL)
2150
STEXI
2151

    
2152
@item -echr @var{numeric_ascii_value}
2153
@findex -echr
2154
Change the escape character used for switching to the monitor when using
2155
monitor and serial sharing.  The default is @code{0x01} when using the
2156
@code{-nographic} option.  @code{0x01} is equal to pressing
2157
@code{Control-a}.  You can select a different character from the ascii
2158
control keys where 1 through 26 map to Control-a through Control-z.  For
2159
instance you could use the either of the following to change the escape
2160
character to Control-t.
2161
@table @code
2162
@item -echr 0x14
2163
@item -echr 20
2164
@end table
2165
ETEXI
2166

    
2167
DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \
2168
    "-virtioconsole c\n" \
2169
    "                set virtio console\n", QEMU_ARCH_ALL)
2170
STEXI
2171
@item -virtioconsole @var{c}
2172
@findex -virtioconsole
2173
Set virtio console.
2174

    
2175
This option is maintained for backward compatibility.
2176

    
2177
Please use @code{-device virtconsole} for the new way of invocation.
2178
ETEXI
2179

    
2180
DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \
2181
    "-show-cursor    show cursor\n", QEMU_ARCH_ALL)
2182
STEXI
2183
@item -show-cursor
2184
@findex -show-cursor
2185
Show cursor.
2186
ETEXI
2187

    
2188
DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \
2189
    "-tb-size n      set TB size\n", QEMU_ARCH_ALL)
2190
STEXI
2191
@item -tb-size @var{n}
2192
@findex -tb-size
2193
Set TB size.
2194
ETEXI
2195

    
2196
DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \
2197
    "-incoming p     prepare for incoming migration, listen on port p\n",
2198
    QEMU_ARCH_ALL)
2199
STEXI
2200
@item -incoming @var{port}
2201
@findex -incoming
2202
Prepare for incoming migration, listen on @var{port}.
2203
ETEXI
2204

    
2205
DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \
2206
    "-nodefaults     don't create default devices\n", QEMU_ARCH_ALL)
2207
STEXI
2208
@item -nodefaults
2209
@findex -nodefaults
2210
Don't create default devices.
2211
ETEXI
2212

    
2213
#ifndef _WIN32
2214
DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \
2215
    "-chroot dir     chroot to dir just before starting the VM\n",
2216
    QEMU_ARCH_ALL)
2217
#endif
2218
STEXI
2219
@item -chroot @var{dir}
2220
@findex -chroot
2221
Immediately before starting guest execution, chroot to the specified
2222
directory.  Especially useful in combination with -runas.
2223
ETEXI
2224

    
2225
#ifndef _WIN32
2226
DEF("runas", HAS_ARG, QEMU_OPTION_runas, \
2227
    "-runas user     change to user id user just before starting the VM\n",
2228
    QEMU_ARCH_ALL)
2229
#endif
2230
STEXI
2231
@item -runas @var{user}
2232
@findex -runas
2233
Immediately before starting guest execution, drop root privileges, switching
2234
to the specified user.
2235
ETEXI
2236

    
2237
DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
2238
    "-prom-env variable=value\n"
2239
    "                set OpenBIOS nvram variables\n",
2240
    QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
2241
STEXI
2242
@item -prom-env @var{variable}=@var{value}
2243
@findex -prom-env
2244
Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only).
2245
ETEXI
2246
DEF("semihosting", 0, QEMU_OPTION_semihosting,
2247
    "-semihosting    semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K)
2248
STEXI
2249
@item -semihosting
2250
@findex -semihosting
2251
Semihosting mode (ARM, M68K only).
2252
ETEXI
2253
DEF("old-param", 0, QEMU_OPTION_old_param,
2254
    "-old-param      old param mode\n", QEMU_ARCH_ARM)
2255
STEXI
2256
@item -old-param
2257
@findex -old-param (ARM)
2258
Old param mode (ARM only).
2259
ETEXI
2260

    
2261
DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig,
2262
    "-readconfig <file>\n", QEMU_ARCH_ALL)
2263
STEXI
2264
@item -readconfig @var{file}
2265
@findex -readconfig
2266
Read device configuration from @var{file}.
2267
ETEXI
2268
DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig,
2269
    "-writeconfig <file>\n"
2270
    "                read/write config file\n", QEMU_ARCH_ALL)
2271
STEXI
2272
@item -writeconfig @var{file}
2273
@findex -writeconfig
2274
Write device configuration to @var{file}.
2275
ETEXI
2276
DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig,
2277
    "-nodefconfig\n"
2278
    "                do not load default config files at startup\n",
2279
    QEMU_ARCH_ALL)
2280
STEXI
2281
@item -nodefconfig
2282
@findex -nodefconfig
2283
Normally QEMU loads a configuration file from @var{sysconfdir}/qemu.conf and
2284
@var{sysconfdir}/target-@var{ARCH}.conf on startup.  The @code{-nodefconfig}
2285
option will prevent QEMU from loading these configuration files at startup.
2286
ETEXI
2287
#ifdef CONFIG_SIMPLE_TRACE
2288
DEF("trace", HAS_ARG, QEMU_OPTION_trace,
2289
    "-trace\n"
2290
    "                Specify a trace file to log traces to\n",
2291
    QEMU_ARCH_ALL)
2292
STEXI
2293
@item -trace
2294
@findex -trace
2295
Specify a trace file to log output traces to.
2296
ETEXI
2297
#endif
2298

    
2299
HXCOMM This is the last statement. Insert new options before this line!
2300
STEXI
2301
@end table
2302
ETEXI