Statistics
| Branch: | Revision:

root / qemu-options.hx @ df97b920

History | View | Annotate | Download (52.9 kB)

1 5824d651 blueswir1
HXCOMM Use DEFHEADING() to define headings in both help text and texi
2 5824d651 blueswir1
HXCOMM Text between STEXI and ETEXI are copied to texi version and
3 5824d651 blueswir1
HXCOMM discarded from C version
4 5824d651 blueswir1
HXCOMM DEF(option, HAS_ARG/0, opt_enum, opt_help) is used to construct
5 5824d651 blueswir1
HXCOMM option structures, enums and help message.
6 5824d651 blueswir1
HXCOMM HXCOMM can be used for comments, discarded from both texi and C
7 5824d651 blueswir1
8 5824d651 blueswir1
DEFHEADING(Standard options:)
9 5824d651 blueswir1
STEXI
10 5824d651 blueswir1
@table @option
11 5824d651 blueswir1
ETEXI
12 5824d651 blueswir1
13 5824d651 blueswir1
DEF("help", 0, QEMU_OPTION_h,
14 5824d651 blueswir1
    "-h or -help     display this help and exit\n")
15 5824d651 blueswir1
STEXI
16 5824d651 blueswir1
@item -h
17 5824d651 blueswir1
Display help and exit
18 5824d651 blueswir1
ETEXI
19 5824d651 blueswir1
20 9bd7e6d9 pbrook
DEF("version", 0, QEMU_OPTION_version,
21 9bd7e6d9 pbrook
    "-version        display version information and exit\n")
22 9bd7e6d9 pbrook
STEXI
23 9bd7e6d9 pbrook
@item -version
24 9bd7e6d9 pbrook
Display version information and exit
25 9bd7e6d9 pbrook
ETEXI
26 9bd7e6d9 pbrook
27 5824d651 blueswir1
DEF("M", HAS_ARG, QEMU_OPTION_M,
28 5824d651 blueswir1
    "-M machine      select emulated machine (-M ? for list)\n")
29 5824d651 blueswir1
STEXI
30 5824d651 blueswir1
@item -M @var{machine}
31 5824d651 blueswir1
Select the emulated @var{machine} (@code{-M ?} for list)
32 5824d651 blueswir1
ETEXI
33 5824d651 blueswir1
34 5824d651 blueswir1
DEF("cpu", HAS_ARG, QEMU_OPTION_cpu,
35 5824d651 blueswir1
    "-cpu cpu        select CPU (-cpu ? for list)\n")
36 5824d651 blueswir1
STEXI
37 5824d651 blueswir1
@item -cpu @var{model}
38 5824d651 blueswir1
Select CPU model (-cpu ? for list and additional feature selection)
39 5824d651 blueswir1
ETEXI
40 5824d651 blueswir1
41 5824d651 blueswir1
DEF("smp", HAS_ARG, QEMU_OPTION_smp,
42 5824d651 blueswir1
    "-smp n          set the number of CPUs to 'n' [default=1]\n")
43 5824d651 blueswir1
STEXI
44 5824d651 blueswir1
@item -smp @var{n}
45 5824d651 blueswir1
Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
46 5824d651 blueswir1
CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs
47 5824d651 blueswir1
to 4.
48 5824d651 blueswir1
ETEXI
49 5824d651 blueswir1
50 268a362c aliguori
DEF("numa", HAS_ARG, QEMU_OPTION_numa,
51 268a362c aliguori
    "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n")
52 268a362c aliguori
STEXI
53 268a362c aliguori
@item -numa @var{opts}
54 268a362c aliguori
Simulate a multi node NUMA system. If mem and cpus are omitted, resources
55 268a362c aliguori
are split equally.
56 268a362c aliguori
ETEXI
57 268a362c aliguori
58 5824d651 blueswir1
DEF("fda", HAS_ARG, QEMU_OPTION_fda,
59 5824d651 blueswir1
    "-fda/-fdb file  use 'file' as floppy disk 0/1 image\n")
60 5824d651 blueswir1
DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "")
61 5824d651 blueswir1
STEXI
62 5824d651 blueswir1
@item -fda @var{file}
63 5824d651 blueswir1
@item -fdb @var{file}
64 5824d651 blueswir1
Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can
65 5824d651 blueswir1
use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}).
66 5824d651 blueswir1
ETEXI
67 5824d651 blueswir1
68 5824d651 blueswir1
DEF("hda", HAS_ARG, QEMU_OPTION_hda,
69 5824d651 blueswir1
    "-hda/-hdb file  use 'file' as IDE hard disk 0/1 image\n")
70 5824d651 blueswir1
DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "")
71 5824d651 blueswir1
DEF("hdc", HAS_ARG, QEMU_OPTION_hdc,
72 5824d651 blueswir1
    "-hdc/-hdd file  use 'file' as IDE hard disk 2/3 image\n")
73 5824d651 blueswir1
DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "")
74 5824d651 blueswir1
STEXI
75 5824d651 blueswir1
@item -hda @var{file}
76 5824d651 blueswir1
@item -hdb @var{file}
77 5824d651 blueswir1
@item -hdc @var{file}
78 5824d651 blueswir1
@item -hdd @var{file}
79 5824d651 blueswir1
Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
80 5824d651 blueswir1
ETEXI
81 5824d651 blueswir1
82 5824d651 blueswir1
DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom,
83 5824d651 blueswir1
    "-cdrom file     use 'file' as IDE cdrom image (cdrom is ide1 master)\n")
84 5824d651 blueswir1
STEXI
85 5824d651 blueswir1
@item -cdrom @var{file}
86 5824d651 blueswir1
Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and
87 5824d651 blueswir1
@option{-cdrom} at the same time). You can use the host CD-ROM by
88 5824d651 blueswir1
using @file{/dev/cdrom} as filename (@pxref{host_drives}).
89 5824d651 blueswir1
ETEXI
90 5824d651 blueswir1
91 5824d651 blueswir1
DEF("drive", HAS_ARG, QEMU_OPTION_drive,
92 5824d651 blueswir1
    "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
93 5824d651 blueswir1
    "       [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n"
94 5824d651 blueswir1
    "       [,cache=writethrough|writeback|none][,format=f][,serial=s]\n"
95 5824d651 blueswir1
    "                use 'file' as a drive image\n")
96 5824d651 blueswir1
STEXI
97 5824d651 blueswir1
@item -drive @var{option}[,@var{option}[,@var{option}[,...]]]
98 5824d651 blueswir1
99 5824d651 blueswir1
Define a new drive. Valid options are:
100 5824d651 blueswir1
101 5824d651 blueswir1
@table @code
102 5824d651 blueswir1
@item file=@var{file}
103 5824d651 blueswir1
This option defines which disk image (@pxref{disk_images}) to use with
104 5824d651 blueswir1
this drive. If the filename contains comma, you must double it
105 5824d651 blueswir1
(for instance, "file=my,,file" to use file "my,file").
106 5824d651 blueswir1
@item if=@var{interface}
107 5824d651 blueswir1
This option defines on which type on interface the drive is connected.
108 5824d651 blueswir1
Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio.
109 5824d651 blueswir1
@item bus=@var{bus},unit=@var{unit}
110 5824d651 blueswir1
These options define where is connected the drive by defining the bus number and
111 5824d651 blueswir1
the unit id.
112 5824d651 blueswir1
@item index=@var{index}
113 5824d651 blueswir1
This option defines where is connected the drive by using an index in the list
114 5824d651 blueswir1
of available connectors of a given interface type.
115 5824d651 blueswir1
@item media=@var{media}
116 5824d651 blueswir1
This option defines the type of the media: disk or cdrom.
117 5824d651 blueswir1
@item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}]
118 5824d651 blueswir1
These options have the same definition as they have in @option{-hdachs}.
119 5824d651 blueswir1
@item snapshot=@var{snapshot}
120 5824d651 blueswir1
@var{snapshot} is "on" or "off" and allows to enable snapshot for given drive (see @option{-snapshot}).
121 5824d651 blueswir1
@item cache=@var{cache}
122 5824d651 blueswir1
@var{cache} is "none", "writeback", or "writethrough" and controls how the host cache is used to access block data.
123 5824d651 blueswir1
@item format=@var{format}
124 5824d651 blueswir1
Specify which disk @var{format} will be used rather than detecting
125 5824d651 blueswir1
the format.  Can be used to specifiy format=raw to avoid interpreting
126 5824d651 blueswir1
an untrusted format header.
127 5824d651 blueswir1
@item serial=@var{serial}
128 5824d651 blueswir1
This option specifies the serial number to assign to the device.
129 5824d651 blueswir1
@end table
130 5824d651 blueswir1
131 5824d651 blueswir1
By default, writethrough caching is used for all block device.  This means that
132 5824d651 blueswir1
the host page cache will be used to read and write data but write notification
133 5824d651 blueswir1
will be sent to the guest only when the data has been reported as written by
134 5824d651 blueswir1
the storage subsystem.
135 5824d651 blueswir1
136 5824d651 blueswir1
Writeback caching will report data writes as completed as soon as the data is
137 5824d651 blueswir1
present in the host page cache.  This is safe as long as you trust your host.
138 5824d651 blueswir1
If your host crashes or loses power, then the guest may experience data
139 5824d651 blueswir1
corruption.  When using the @option{-snapshot} option, writeback caching is
140 5824d651 blueswir1
used by default.
141 5824d651 blueswir1
142 c304d317 Aurelien Jarno
The host page cache can be avoided entirely with @option{cache=none}.  This will
143 5824d651 blueswir1
attempt to do disk IO directly to the guests memory.  QEMU may still perform
144 5824d651 blueswir1
an internal copy of the data.
145 5824d651 blueswir1
146 5824d651 blueswir1
Some block drivers perform badly with @option{cache=writethrough}, most notably,
147 5824d651 blueswir1
qcow2.  If performance is more important than correctness,
148 5824d651 blueswir1
@option{cache=writeback} should be used with qcow2.  By default, if no explicit
149 5824d651 blueswir1
caching is specified for a qcow2 disk image, @option{cache=writeback} will be
150 5824d651 blueswir1
used.  For all other disk types, @option{cache=writethrough} is the default.
151 5824d651 blueswir1
152 5824d651 blueswir1
Instead of @option{-cdrom} you can use:
153 5824d651 blueswir1
@example
154 5824d651 blueswir1
qemu -drive file=file,index=2,media=cdrom
155 5824d651 blueswir1
@end example
156 5824d651 blueswir1
157 5824d651 blueswir1
Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
158 5824d651 blueswir1
use:
159 5824d651 blueswir1
@example
160 5824d651 blueswir1
qemu -drive file=file,index=0,media=disk
161 5824d651 blueswir1
qemu -drive file=file,index=1,media=disk
162 5824d651 blueswir1
qemu -drive file=file,index=2,media=disk
163 5824d651 blueswir1
qemu -drive file=file,index=3,media=disk
164 5824d651 blueswir1
@end example
165 5824d651 blueswir1
166 5824d651 blueswir1
You can connect a CDROM to the slave of ide0:
167 5824d651 blueswir1
@example
168 5824d651 blueswir1
qemu -drive file=file,if=ide,index=1,media=cdrom
169 5824d651 blueswir1
@end example
170 5824d651 blueswir1
171 5824d651 blueswir1
If you don't specify the "file=" argument, you define an empty drive:
172 5824d651 blueswir1
@example
173 5824d651 blueswir1
qemu -drive if=ide,index=1,media=cdrom
174 5824d651 blueswir1
@end example
175 5824d651 blueswir1
176 5824d651 blueswir1
You can connect a SCSI disk with unit ID 6 on the bus #0:
177 5824d651 blueswir1
@example
178 5824d651 blueswir1
qemu -drive file=file,if=scsi,bus=0,unit=6
179 5824d651 blueswir1
@end example
180 5824d651 blueswir1
181 5824d651 blueswir1
Instead of @option{-fda}, @option{-fdb}, you can use:
182 5824d651 blueswir1
@example
183 5824d651 blueswir1
qemu -drive file=file,index=0,if=floppy
184 5824d651 blueswir1
qemu -drive file=file,index=1,if=floppy
185 5824d651 blueswir1
@end example
186 5824d651 blueswir1
187 5824d651 blueswir1
By default, @var{interface} is "ide" and @var{index} is automatically
188 5824d651 blueswir1
incremented:
189 5824d651 blueswir1
@example
190 5824d651 blueswir1
qemu -drive file=a -drive file=b"
191 5824d651 blueswir1
@end example
192 5824d651 blueswir1
is interpreted like:
193 5824d651 blueswir1
@example
194 5824d651 blueswir1
qemu -hda a -hdb b
195 5824d651 blueswir1
@end example
196 5824d651 blueswir1
ETEXI
197 5824d651 blueswir1
198 5824d651 blueswir1
DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock,
199 5824d651 blueswir1
    "-mtdblock file  use 'file' as on-board Flash memory image\n")
200 5824d651 blueswir1
STEXI
201 5824d651 blueswir1
202 5824d651 blueswir1
@item -mtdblock file
203 5824d651 blueswir1
Use 'file' as on-board Flash memory image.
204 5824d651 blueswir1
ETEXI
205 5824d651 blueswir1
206 5824d651 blueswir1
DEF("sd", HAS_ARG, QEMU_OPTION_sd,
207 5824d651 blueswir1
    "-sd file        use 'file' as SecureDigital card image\n")
208 5824d651 blueswir1
STEXI
209 5824d651 blueswir1
@item -sd file
210 5824d651 blueswir1
Use 'file' as SecureDigital card image.
211 5824d651 blueswir1
ETEXI
212 5824d651 blueswir1
213 5824d651 blueswir1
DEF("pflash", HAS_ARG, QEMU_OPTION_pflash,
214 5824d651 blueswir1
    "-pflash file    use 'file' as a parallel flash image\n")
215 5824d651 blueswir1
STEXI
216 5824d651 blueswir1
@item -pflash file
217 5824d651 blueswir1
Use 'file' as a parallel flash image.
218 5824d651 blueswir1
ETEXI
219 5824d651 blueswir1
220 5824d651 blueswir1
DEF("boot", HAS_ARG, QEMU_OPTION_boot,
221 5824d651 blueswir1
    "-boot [a|c|d|n] boot on floppy (a), hard disk (c), CD-ROM (d), or network (n)\n")
222 5824d651 blueswir1
STEXI
223 5824d651 blueswir1
@item -boot [a|c|d|n]
224 5824d651 blueswir1
Boot on floppy (a), hard disk (c), CD-ROM (d), or Etherboot (n). Hard disk boot
225 5824d651 blueswir1
is the default.
226 5824d651 blueswir1
ETEXI
227 5824d651 blueswir1
228 5824d651 blueswir1
DEF("snapshot", 0, QEMU_OPTION_snapshot,
229 5824d651 blueswir1
    "-snapshot       write to temporary files instead of disk image files\n")
230 5824d651 blueswir1
STEXI
231 5824d651 blueswir1
@item -snapshot
232 5824d651 blueswir1
Write to temporary files instead of disk image files. In this case,
233 5824d651 blueswir1
the raw disk image you use is not written back. You can however force
234 5824d651 blueswir1
the write back by pressing @key{C-a s} (@pxref{disk_images}).
235 5824d651 blueswir1
ETEXI
236 5824d651 blueswir1
237 5824d651 blueswir1
DEF("m", HAS_ARG, QEMU_OPTION_m,
238 5824d651 blueswir1
    "-m megs         set virtual RAM size to megs MB [default=%d]\n")
239 5824d651 blueswir1
STEXI
240 5824d651 blueswir1
@item -m @var{megs}
241 5824d651 blueswir1
Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB.  Optionally,
242 5824d651 blueswir1
a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
243 5824d651 blueswir1
gigabytes respectively.
244 5824d651 blueswir1
ETEXI
245 5824d651 blueswir1
246 5824d651 blueswir1
DEF("k", HAS_ARG, QEMU_OPTION_k,
247 5c2f8d2d blueswir1
    "-k language     use keyboard layout (for example 'fr' for French)\n")
248 5824d651 blueswir1
STEXI
249 5824d651 blueswir1
@item -k @var{language}
250 5824d651 blueswir1
251 5824d651 blueswir1
Use keyboard layout @var{language} (for example @code{fr} for
252 5824d651 blueswir1
French). This option is only needed where it is not easy to get raw PC
253 5824d651 blueswir1
keycodes (e.g. on Macs, with some X11 servers or with a VNC
254 5824d651 blueswir1
display). You don't normally need to use it on PC/Linux or PC/Windows
255 5824d651 blueswir1
hosts.
256 5824d651 blueswir1
257 5824d651 blueswir1
The available layouts are:
258 5824d651 blueswir1
@example
259 5824d651 blueswir1
ar  de-ch  es  fo     fr-ca  hu  ja  mk     no  pt-br  sv
260 5824d651 blueswir1
da  en-gb  et  fr     fr-ch  is  lt  nl     pl  ru     th
261 5824d651 blueswir1
de  en-us  fi  fr-be  hr     it  lv  nl-be  pt  sl     tr
262 5824d651 blueswir1
@end example
263 5824d651 blueswir1
264 5824d651 blueswir1
The default is @code{en-us}.
265 5824d651 blueswir1
ETEXI
266 5824d651 blueswir1
267 5824d651 blueswir1
268 5824d651 blueswir1
#ifdef HAS_AUDIO
269 5824d651 blueswir1
DEF("audio-help", 0, QEMU_OPTION_audio_help,
270 5824d651 blueswir1
    "-audio-help     print list of audio drivers and their options\n")
271 5824d651 blueswir1
#endif
272 5824d651 blueswir1
STEXI
273 5824d651 blueswir1
@item -audio-help
274 5824d651 blueswir1
275 5824d651 blueswir1
Will show the audio subsystem help: list of drivers, tunable
276 5824d651 blueswir1
parameters.
277 5824d651 blueswir1
ETEXI
278 5824d651 blueswir1
279 5824d651 blueswir1
#ifdef HAS_AUDIO
280 5824d651 blueswir1
DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw,
281 5824d651 blueswir1
    "-soundhw c1,... enable audio support\n"
282 5824d651 blueswir1
    "                and only specified sound cards (comma separated list)\n"
283 5824d651 blueswir1
    "                use -soundhw ? to get the list of supported cards\n"
284 5824d651 blueswir1
    "                use -soundhw all to enable all of them\n")
285 5824d651 blueswir1
#endif
286 5824d651 blueswir1
STEXI
287 5824d651 blueswir1
@item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
288 5824d651 blueswir1
289 5824d651 blueswir1
Enable audio and selected sound hardware. Use ? to print all
290 5824d651 blueswir1
available sound hardware.
291 5824d651 blueswir1
292 5824d651 blueswir1
@example
293 5824d651 blueswir1
qemu -soundhw sb16,adlib disk.img
294 5824d651 blueswir1
qemu -soundhw es1370 disk.img
295 5824d651 blueswir1
qemu -soundhw ac97 disk.img
296 5824d651 blueswir1
qemu -soundhw all disk.img
297 5824d651 blueswir1
qemu -soundhw ?
298 5824d651 blueswir1
@end example
299 5824d651 blueswir1
300 5824d651 blueswir1
Note that Linux's i810_audio OSS kernel (for AC97) module might
301 5824d651 blueswir1
require manually specifying clocking.
302 5824d651 blueswir1
303 5824d651 blueswir1
@example
304 5824d651 blueswir1
modprobe i810_audio clocking=48000
305 5824d651 blueswir1
@end example
306 5824d651 blueswir1
ETEXI
307 5824d651 blueswir1
308 5824d651 blueswir1
STEXI
309 5824d651 blueswir1
@end table
310 5824d651 blueswir1
ETEXI
311 5824d651 blueswir1
312 5824d651 blueswir1
DEF("usb", 0, QEMU_OPTION_usb,
313 5824d651 blueswir1
    "-usb            enable the USB driver (will be the default soon)\n")
314 5824d651 blueswir1
STEXI
315 5824d651 blueswir1
USB options:
316 5824d651 blueswir1
@table @option
317 5824d651 blueswir1
318 5824d651 blueswir1
@item -usb
319 5824d651 blueswir1
Enable the USB driver (will be the default soon)
320 5824d651 blueswir1
ETEXI
321 5824d651 blueswir1
322 5824d651 blueswir1
DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
323 5824d651 blueswir1
    "-usbdevice name add the host or guest USB device 'name'\n")
324 5824d651 blueswir1
STEXI
325 5824d651 blueswir1
326 5824d651 blueswir1
@item -usbdevice @var{devname}
327 5824d651 blueswir1
Add the USB device @var{devname}. @xref{usb_devices}.
328 5824d651 blueswir1
329 5824d651 blueswir1
@table @code
330 5824d651 blueswir1
331 5824d651 blueswir1
@item mouse
332 5824d651 blueswir1
Virtual Mouse. This will override the PS/2 mouse emulation when activated.
333 5824d651 blueswir1
334 5824d651 blueswir1
@item tablet
335 5824d651 blueswir1
Pointer device that uses absolute coordinates (like a touchscreen). This
336 5824d651 blueswir1
means qemu is able to report the mouse position without having to grab the
337 5824d651 blueswir1
mouse. Also overrides the PS/2 mouse emulation when activated.
338 5824d651 blueswir1
339 5824d651 blueswir1
@item disk:[format=@var{format}]:file
340 5824d651 blueswir1
Mass storage device based on file. The optional @var{format} argument
341 5824d651 blueswir1
will be used rather than detecting the format. Can be used to specifiy
342 5824d651 blueswir1
format=raw to avoid interpreting an untrusted format header.
343 5824d651 blueswir1
344 5824d651 blueswir1
@item host:bus.addr
345 5824d651 blueswir1
Pass through the host device identified by bus.addr (Linux only).
346 5824d651 blueswir1
347 5824d651 blueswir1
@item host:vendor_id:product_id
348 5824d651 blueswir1
Pass through the host device identified by vendor_id:product_id (Linux only).
349 5824d651 blueswir1
350 5824d651 blueswir1
@item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
351 5824d651 blueswir1
Serial converter to host character device @var{dev}, see @code{-serial} for the
352 5824d651 blueswir1
available devices.
353 5824d651 blueswir1
354 5824d651 blueswir1
@item braille
355 5824d651 blueswir1
Braille device.  This will use BrlAPI to display the braille output on a real
356 5824d651 blueswir1
or fake device.
357 5824d651 blueswir1
358 5824d651 blueswir1
@item net:options
359 5824d651 blueswir1
Network adapter that supports CDC ethernet and RNDIS protocols.
360 5824d651 blueswir1
361 5824d651 blueswir1
@end table
362 5824d651 blueswir1
ETEXI
363 5824d651 blueswir1
364 5824d651 blueswir1
DEF("name", HAS_ARG, QEMU_OPTION_name,
365 5824d651 blueswir1
    "-name string    set the name of the guest\n")
366 5824d651 blueswir1
STEXI
367 5824d651 blueswir1
@item -name @var{name}
368 5824d651 blueswir1
Sets the @var{name} of the guest.
369 5824d651 blueswir1
This name will be displayed in the SDL window caption.
370 5824d651 blueswir1
The @var{name} will also be used for the VNC server.
371 5824d651 blueswir1
ETEXI
372 5824d651 blueswir1
373 5824d651 blueswir1
DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
374 5824d651 blueswir1
    "-uuid %%08x-%%04x-%%04x-%%04x-%%012x\n"
375 5824d651 blueswir1
    "                specify machine UUID\n")
376 5824d651 blueswir1
STEXI
377 5824d651 blueswir1
@item -uuid @var{uuid}
378 5824d651 blueswir1
Set system UUID.
379 5824d651 blueswir1
ETEXI
380 5824d651 blueswir1
381 5824d651 blueswir1
STEXI
382 5824d651 blueswir1
@end table
383 5824d651 blueswir1
ETEXI
384 5824d651 blueswir1
385 5824d651 blueswir1
DEFHEADING()
386 5824d651 blueswir1
387 5824d651 blueswir1
DEFHEADING(Display options:)
388 5824d651 blueswir1
389 5824d651 blueswir1
STEXI
390 5824d651 blueswir1
@table @option
391 5824d651 blueswir1
ETEXI
392 5824d651 blueswir1
393 5824d651 blueswir1
DEF("nographic", 0, QEMU_OPTION_nographic,
394 5824d651 blueswir1
    "-nographic      disable graphical output and redirect serial I/Os to console\n")
395 5824d651 blueswir1
STEXI
396 5824d651 blueswir1
@item -nographic
397 5824d651 blueswir1
398 5824d651 blueswir1
Normally, QEMU uses SDL to display the VGA output. With this option,
399 5824d651 blueswir1
you can totally disable graphical output so that QEMU is a simple
400 5824d651 blueswir1
command line application. The emulated serial port is redirected on
401 5824d651 blueswir1
the console. Therefore, you can still use QEMU to debug a Linux kernel
402 5824d651 blueswir1
with a serial console.
403 5824d651 blueswir1
ETEXI
404 5824d651 blueswir1
405 5824d651 blueswir1
#ifdef CONFIG_CURSES
406 5824d651 blueswir1
DEF("curses", 0, QEMU_OPTION_curses,
407 5824d651 blueswir1
    "-curses         use a curses/ncurses interface instead of SDL\n")
408 5824d651 blueswir1
#endif
409 5824d651 blueswir1
STEXI
410 5824d651 blueswir1
@item -curses
411 5824d651 blueswir1
412 5824d651 blueswir1
Normally, QEMU uses SDL to display the VGA output.  With this option,
413 5824d651 blueswir1
QEMU can display the VGA output when in text mode using a
414 5824d651 blueswir1
curses/ncurses interface.  Nothing is displayed in graphical mode.
415 5824d651 blueswir1
ETEXI
416 5824d651 blueswir1
417 5824d651 blueswir1
#ifdef CONFIG_SDL
418 5824d651 blueswir1
DEF("no-frame", 0, QEMU_OPTION_no_frame,
419 5824d651 blueswir1
    "-no-frame       open SDL window without a frame and window decorations\n")
420 5824d651 blueswir1
#endif
421 5824d651 blueswir1
STEXI
422 5824d651 blueswir1
@item -no-frame
423 5824d651 blueswir1
424 5824d651 blueswir1
Do not use decorations for SDL windows and start them using the whole
425 5824d651 blueswir1
available screen space. This makes the using QEMU in a dedicated desktop
426 5824d651 blueswir1
workspace more convenient.
427 5824d651 blueswir1
ETEXI
428 5824d651 blueswir1
429 5824d651 blueswir1
#ifdef CONFIG_SDL
430 5824d651 blueswir1
DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
431 5824d651 blueswir1
    "-alt-grab       use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n")
432 5824d651 blueswir1
#endif
433 5824d651 blueswir1
STEXI
434 5824d651 blueswir1
@item -alt-grab
435 5824d651 blueswir1
436 5824d651 blueswir1
Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt).
437 5824d651 blueswir1
ETEXI
438 5824d651 blueswir1
439 5824d651 blueswir1
#ifdef CONFIG_SDL
440 5824d651 blueswir1
DEF("no-quit", 0, QEMU_OPTION_no_quit,
441 5824d651 blueswir1
    "-no-quit        disable SDL window close capability\n")
442 5824d651 blueswir1
#endif
443 5824d651 blueswir1
STEXI
444 5824d651 blueswir1
@item -no-quit
445 5824d651 blueswir1
446 5824d651 blueswir1
Disable SDL window close capability.
447 5824d651 blueswir1
ETEXI
448 5824d651 blueswir1
449 5824d651 blueswir1
#ifdef CONFIG_SDL
450 5824d651 blueswir1
DEF("sdl", 0, QEMU_OPTION_sdl,
451 5824d651 blueswir1
    "-sdl            enable SDL\n")
452 5824d651 blueswir1
#endif
453 5824d651 blueswir1
STEXI
454 5824d651 blueswir1
@item -sdl
455 5824d651 blueswir1
456 5824d651 blueswir1
Enable SDL.
457 5824d651 blueswir1
ETEXI
458 5824d651 blueswir1
459 5824d651 blueswir1
DEF("portrait", 0, QEMU_OPTION_portrait,
460 5824d651 blueswir1
    "-portrait       rotate graphical output 90 deg left (only PXA LCD)\n")
461 5824d651 blueswir1
STEXI
462 5824d651 blueswir1
@item -portrait
463 5824d651 blueswir1
464 5824d651 blueswir1
Rotate graphical output 90 deg left (only PXA LCD).
465 5824d651 blueswir1
ETEXI
466 5824d651 blueswir1
467 5824d651 blueswir1
DEF("vga", HAS_ARG, QEMU_OPTION_vga,
468 94909d9f aliguori
    "-vga [std|cirrus|vmware|xenfb|none]\n"
469 5824d651 blueswir1
    "                select video card type\n")
470 5824d651 blueswir1
STEXI
471 5824d651 blueswir1
@item -vga @var{type}
472 5824d651 blueswir1
Select type of VGA card to emulate. Valid values for @var{type} are
473 5824d651 blueswir1
@table @code
474 5824d651 blueswir1
@item cirrus
475 5824d651 blueswir1
Cirrus Logic GD5446 Video card. All Windows versions starting from
476 5824d651 blueswir1
Windows 95 should recognize and use this graphic card. For optimal
477 5824d651 blueswir1
performances, use 16 bit color depth in the guest and the host OS.
478 5824d651 blueswir1
(This one is the default)
479 5824d651 blueswir1
@item std
480 5824d651 blueswir1
Standard VGA card with Bochs VBE extensions.  If your guest OS
481 5824d651 blueswir1
supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
482 5824d651 blueswir1
to use high resolution modes (>= 1280x1024x16) then you should use
483 5824d651 blueswir1
this option.
484 5824d651 blueswir1
@item vmware
485 5824d651 blueswir1
VMWare SVGA-II compatible adapter. Use it if you have sufficiently
486 5824d651 blueswir1
recent XFree86/XOrg server or Windows guest with a driver for this
487 5824d651 blueswir1
card.
488 5824d651 blueswir1
@item none
489 5824d651 blueswir1
Disable VGA card.
490 5824d651 blueswir1
@end table
491 5824d651 blueswir1
ETEXI
492 5824d651 blueswir1
493 5824d651 blueswir1
DEF("full-screen", 0, QEMU_OPTION_full_screen,
494 5824d651 blueswir1
    "-full-screen    start in full screen\n")
495 5824d651 blueswir1
STEXI
496 5824d651 blueswir1
@item -full-screen
497 5824d651 blueswir1
Start in full screen.
498 5824d651 blueswir1
ETEXI
499 5824d651 blueswir1
500 5824d651 blueswir1
#if defined(TARGET_PPC) || defined(TARGET_SPARC)
501 5824d651 blueswir1
DEF("g", 1, QEMU_OPTION_g ,
502 5824d651 blueswir1
    "-g WxH[xDEPTH]  Set the initial graphical resolution and depth\n")
503 5824d651 blueswir1
#endif
504 5824d651 blueswir1
STEXI
505 5824d651 blueswir1
ETEXI
506 5824d651 blueswir1
507 5824d651 blueswir1
DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
508 5824d651 blueswir1
    "-vnc display    start a VNC server on display\n")
509 5824d651 blueswir1
STEXI
510 5824d651 blueswir1
@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
511 5824d651 blueswir1
512 5824d651 blueswir1
Normally, QEMU uses SDL to display the VGA output.  With this option,
513 5824d651 blueswir1
you can have QEMU listen on VNC display @var{display} and redirect the VGA
514 5824d651 blueswir1
display over the VNC session.  It is very useful to enable the usb
515 5824d651 blueswir1
tablet device when using this option (option @option{-usbdevice
516 5824d651 blueswir1
tablet}). When using the VNC display, you must use the @option{-k}
517 5824d651 blueswir1
parameter to set the keyboard layout if you are not using en-us. Valid
518 5824d651 blueswir1
syntax for the @var{display} is
519 5824d651 blueswir1
520 5824d651 blueswir1
@table @code
521 5824d651 blueswir1
522 5824d651 blueswir1
@item @var{host}:@var{d}
523 5824d651 blueswir1
524 5824d651 blueswir1
TCP connections will only be allowed from @var{host} on display @var{d}.
525 5824d651 blueswir1
By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
526 5824d651 blueswir1
be omitted in which case the server will accept connections from any host.
527 5824d651 blueswir1
528 5824d651 blueswir1
@item @code{unix}:@var{path}
529 5824d651 blueswir1
530 5824d651 blueswir1
Connections will be allowed over UNIX domain sockets where @var{path} is the
531 5824d651 blueswir1
location of a unix socket to listen for connections on.
532 5824d651 blueswir1
533 5824d651 blueswir1
@item none
534 5824d651 blueswir1
535 5824d651 blueswir1
VNC is initialized but not started. The monitor @code{change} command
536 5824d651 blueswir1
can be used to later start the VNC server.
537 5824d651 blueswir1
538 5824d651 blueswir1
@end table
539 5824d651 blueswir1
540 5824d651 blueswir1
Following the @var{display} value there may be one or more @var{option} flags
541 5824d651 blueswir1
separated by commas. Valid options are
542 5824d651 blueswir1
543 5824d651 blueswir1
@table @code
544 5824d651 blueswir1
545 5824d651 blueswir1
@item reverse
546 5824d651 blueswir1
547 5824d651 blueswir1
Connect to a listening VNC client via a ``reverse'' connection. The
548 5824d651 blueswir1
client is specified by the @var{display}. For reverse network
549 5824d651 blueswir1
connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
550 5824d651 blueswir1
is a TCP port number, not a display number.
551 5824d651 blueswir1
552 5824d651 blueswir1
@item password
553 5824d651 blueswir1
554 5824d651 blueswir1
Require that password based authentication is used for client connections.
555 5824d651 blueswir1
The password must be set separately using the @code{change} command in the
556 5824d651 blueswir1
@ref{pcsys_monitor}
557 5824d651 blueswir1
558 5824d651 blueswir1
@item tls
559 5824d651 blueswir1
560 5824d651 blueswir1
Require that client use TLS when communicating with the VNC server. This
561 5824d651 blueswir1
uses anonymous TLS credentials so is susceptible to a man-in-the-middle
562 5824d651 blueswir1
attack. It is recommended that this option be combined with either the
563 5824d651 blueswir1
@var{x509} or @var{x509verify} options.
564 5824d651 blueswir1
565 5824d651 blueswir1
@item x509=@var{/path/to/certificate/dir}
566 5824d651 blueswir1
567 5824d651 blueswir1
Valid if @option{tls} is specified. Require that x509 credentials are used
568 5824d651 blueswir1
for negotiating the TLS session. The server will send its x509 certificate
569 5824d651 blueswir1
to the client. It is recommended that a password be set on the VNC server
570 5824d651 blueswir1
to provide authentication of the client when this is used. The path following
571 5824d651 blueswir1
this option specifies where the x509 certificates are to be loaded from.
572 5824d651 blueswir1
See the @ref{vnc_security} section for details on generating certificates.
573 5824d651 blueswir1
574 5824d651 blueswir1
@item x509verify=@var{/path/to/certificate/dir}
575 5824d651 blueswir1
576 5824d651 blueswir1
Valid if @option{tls} is specified. Require that x509 credentials are used
577 5824d651 blueswir1
for negotiating the TLS session. The server will send its x509 certificate
578 5824d651 blueswir1
to the client, and request that the client send its own x509 certificate.
579 5824d651 blueswir1
The server will validate the client's certificate against the CA certificate,
580 5824d651 blueswir1
and reject clients when validation fails. If the certificate authority is
581 5824d651 blueswir1
trusted, this is a sufficient authentication mechanism. You may still wish
582 5824d651 blueswir1
to set a password on the VNC server as a second authentication layer. The
583 5824d651 blueswir1
path following this option specifies where the x509 certificates are to
584 5824d651 blueswir1
be loaded from. See the @ref{vnc_security} section for details on generating
585 5824d651 blueswir1
certificates.
586 5824d651 blueswir1
587 5824d651 blueswir1
@item sasl
588 5824d651 blueswir1
589 5824d651 blueswir1
Require that the client use SASL to authenticate with the VNC server.
590 5824d651 blueswir1
The exact choice of authentication method used is controlled from the
591 5824d651 blueswir1
system / user's SASL configuration file for the 'qemu' service. This
592 5824d651 blueswir1
is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
593 5824d651 blueswir1
unprivileged user, an environment variable SASL_CONF_PATH can be used
594 5824d651 blueswir1
to make it search alternate locations for the service config.
595 5824d651 blueswir1
While some SASL auth methods can also provide data encryption (eg GSSAPI),
596 5824d651 blueswir1
it is recommended that SASL always be combined with the 'tls' and
597 5824d651 blueswir1
'x509' settings to enable use of SSL and server certificates. This
598 5824d651 blueswir1
ensures a data encryption preventing compromise of authentication
599 5824d651 blueswir1
credentials. See the @ref{vnc_security} section for details on using
600 5824d651 blueswir1
SASL authentication.
601 5824d651 blueswir1
602 5824d651 blueswir1
@item acl
603 5824d651 blueswir1
604 5824d651 blueswir1
Turn on access control lists for checking of the x509 client certificate
605 5824d651 blueswir1
and SASL party. For x509 certs, the ACL check is made against the
606 5824d651 blueswir1
certificate's distinguished name. This is something that looks like
607 5824d651 blueswir1
@code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
608 5824d651 blueswir1
made against the username, which depending on the SASL plugin, may
609 5824d651 blueswir1
include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
610 5824d651 blueswir1
When the @option{acl} flag is set, the initial access list will be
611 5824d651 blueswir1
empty, with a @code{deny} policy. Thus no one will be allowed to
612 5824d651 blueswir1
use the VNC server until the ACLs have been loaded. This can be
613 5824d651 blueswir1
achieved using the @code{acl} monitor command.
614 5824d651 blueswir1
615 5824d651 blueswir1
@end table
616 5824d651 blueswir1
ETEXI
617 5824d651 blueswir1
618 5824d651 blueswir1
STEXI
619 5824d651 blueswir1
@end table
620 5824d651 blueswir1
ETEXI
621 5824d651 blueswir1
622 5824d651 blueswir1
DEFHEADING()
623 5824d651 blueswir1
624 5824d651 blueswir1
#ifdef TARGET_I386
625 5824d651 blueswir1
DEFHEADING(i386 target only:)
626 5824d651 blueswir1
#endif
627 5824d651 blueswir1
STEXI
628 5824d651 blueswir1
@table @option
629 5824d651 blueswir1
ETEXI
630 5824d651 blueswir1
631 5824d651 blueswir1
#ifdef TARGET_I386
632 5824d651 blueswir1
DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack,
633 5824d651 blueswir1
    "-win2k-hack     use it when installing Windows 2000 to avoid a disk full bug\n")
634 5824d651 blueswir1
#endif
635 5824d651 blueswir1
STEXI
636 5824d651 blueswir1
@item -win2k-hack
637 5824d651 blueswir1
Use it when installing Windows 2000 to avoid a disk full bug. After
638 5824d651 blueswir1
Windows 2000 is installed, you no longer need this option (this option
639 5824d651 blueswir1
slows down the IDE transfers).
640 5824d651 blueswir1
ETEXI
641 5824d651 blueswir1
642 5824d651 blueswir1
#ifdef TARGET_I386
643 5824d651 blueswir1
DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack,
644 5824d651 blueswir1
    "-rtc-td-hack    use it to fix time drift in Windows ACPI HAL\n")
645 5824d651 blueswir1
#endif
646 5824d651 blueswir1
STEXI
647 5824d651 blueswir1
@item -rtc-td-hack
648 5824d651 blueswir1
Use it if you experience time drift problem in Windows with ACPI HAL.
649 5824d651 blueswir1
This option will try to figure out how many timer interrupts were not
650 5824d651 blueswir1
processed by the Windows guest and will re-inject them.
651 5824d651 blueswir1
ETEXI
652 5824d651 blueswir1
653 5824d651 blueswir1
#ifdef TARGET_I386
654 5824d651 blueswir1
DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
655 5824d651 blueswir1
    "-no-fd-bootchk  disable boot signature checking for floppy disks\n")
656 5824d651 blueswir1
#endif
657 5824d651 blueswir1
STEXI
658 5824d651 blueswir1
@item -no-fd-bootchk
659 5824d651 blueswir1
Disable boot signature checking for floppy disks in Bochs BIOS. It may
660 5824d651 blueswir1
be needed to boot from old floppy disks.
661 5824d651 blueswir1
ETEXI
662 5824d651 blueswir1
663 5824d651 blueswir1
#ifdef TARGET_I386
664 5824d651 blueswir1
DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
665 5824d651 blueswir1
           "-no-acpi        disable ACPI\n")
666 5824d651 blueswir1
#endif
667 5824d651 blueswir1
STEXI
668 5824d651 blueswir1
@item -no-acpi
669 5824d651 blueswir1
Disable ACPI (Advanced Configuration and Power Interface) support. Use
670 5824d651 blueswir1
it if your guest OS complains about ACPI problems (PC target machine
671 5824d651 blueswir1
only).
672 5824d651 blueswir1
ETEXI
673 5824d651 blueswir1
674 5824d651 blueswir1
#ifdef TARGET_I386
675 5824d651 blueswir1
DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
676 5824d651 blueswir1
    "-no-hpet        disable HPET\n")
677 5824d651 blueswir1
#endif
678 5824d651 blueswir1
STEXI
679 5824d651 blueswir1
@item -no-hpet
680 5824d651 blueswir1
Disable HPET support.
681 5824d651 blueswir1
ETEXI
682 5824d651 blueswir1
683 5824d651 blueswir1
#ifdef TARGET_I386
684 df97b920 Eduardo Habkost
DEF("no-virtio-balloon", 0, QEMU_OPTION_no_virtio_balloon,
685 df97b920 Eduardo Habkost
    "-no-virtio-balloon disable virtio balloon device\n")
686 df97b920 Eduardo Habkost
#endif
687 df97b920 Eduardo Habkost
STEXI
688 df97b920 Eduardo Habkost
@item -no-virtio-balloon
689 df97b920 Eduardo Habkost
Disable virtio-balloon device.
690 df97b920 Eduardo Habkost
ETEXI
691 df97b920 Eduardo Habkost
692 df97b920 Eduardo Habkost
#ifdef TARGET_I386
693 5824d651 blueswir1
DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
694 5824d651 blueswir1
    "-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"
695 5824d651 blueswir1
    "                ACPI table description\n")
696 5824d651 blueswir1
#endif
697 5824d651 blueswir1
STEXI
698 5824d651 blueswir1
@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}]...]
699 5824d651 blueswir1
Add ACPI table with specified header fields and context from specified files.
700 5824d651 blueswir1
ETEXI
701 5824d651 blueswir1
702 5824d651 blueswir1
#ifdef TARGET_I386
703 b6f6e3d3 aliguori
DEF("smbios", HAS_ARG, QEMU_OPTION_smbios,
704 b6f6e3d3 aliguori
    "-smbios file=binary\n"
705 b6f6e3d3 aliguori
    "                Load SMBIOS entry from binary file\n"
706 b6f6e3d3 aliguori
    "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%%d.%%d]\n"
707 b6f6e3d3 aliguori
    "                Specify SMBIOS type 0 fields\n"
708 b6f6e3d3 aliguori
    "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
709 b6f6e3d3 aliguori
    "              [,uuid=uuid][,sku=str][,family=str]\n"
710 b6f6e3d3 aliguori
    "                Specify SMBIOS type 1 fields\n")
711 b6f6e3d3 aliguori
#endif
712 b6f6e3d3 aliguori
STEXI
713 b6f6e3d3 aliguori
@item -smbios file=@var{binary}
714 b6f6e3d3 aliguori
Load SMBIOS entry from binary file.
715 b6f6e3d3 aliguori
716 b6f6e3d3 aliguori
@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}]
717 b6f6e3d3 aliguori
Specify SMBIOS type 0 fields
718 b6f6e3d3 aliguori
719 b6f6e3d3 aliguori
@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}]
720 b6f6e3d3 aliguori
Specify SMBIOS type 1 fields
721 b6f6e3d3 aliguori
ETEXI
722 b6f6e3d3 aliguori
723 b6f6e3d3 aliguori
#ifdef TARGET_I386
724 5824d651 blueswir1
DEFHEADING()
725 5824d651 blueswir1
#endif
726 5824d651 blueswir1
STEXI
727 5824d651 blueswir1
@end table
728 5824d651 blueswir1
ETEXI
729 5824d651 blueswir1
730 5824d651 blueswir1
DEFHEADING(Network options:)
731 5824d651 blueswir1
STEXI
732 5824d651 blueswir1
@table @option
733 5824d651 blueswir1
ETEXI
734 5824d651 blueswir1
735 bab7944c Blue Swirl
DEF("net", HAS_ARG, QEMU_OPTION_net,
736 5824d651 blueswir1
    "-net nic[,vlan=n][,macaddr=addr][,model=type][,name=str]\n"
737 5824d651 blueswir1
    "                create a new Network Interface Card and connect it to VLAN 'n'\n"
738 5824d651 blueswir1
#ifdef CONFIG_SLIRP
739 5824d651 blueswir1
    "-net user[,vlan=n][,name=str][,hostname=host]\n"
740 5824d651 blueswir1
    "                connect the user mode network stack to VLAN 'n' and send\n"
741 5824d651 blueswir1
    "                hostname 'host' to DHCP clients\n"
742 5824d651 blueswir1
#endif
743 5824d651 blueswir1
#ifdef _WIN32
744 5824d651 blueswir1
    "-net tap[,vlan=n][,name=str],ifname=name\n"
745 5824d651 blueswir1
    "                connect the host TAP network interface to VLAN 'n'\n"
746 5824d651 blueswir1
#else
747 5824d651 blueswir1
    "-net tap[,vlan=n][,name=str][,fd=h][,ifname=name][,script=file][,downscript=dfile]\n"
748 5824d651 blueswir1
    "                connect the host TAP network interface to VLAN 'n' and use the\n"
749 5824d651 blueswir1
    "                network scripts 'file' (default=%s)\n"
750 5824d651 blueswir1
    "                and 'dfile' (default=%s);\n"
751 5824d651 blueswir1
    "                use '[down]script=no' to disable script execution;\n"
752 5824d651 blueswir1
    "                use 'fd=h' to connect to an already opened TAP interface\n"
753 5824d651 blueswir1
#endif
754 5824d651 blueswir1
    "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n"
755 5824d651 blueswir1
    "                connect the vlan 'n' to another VLAN using a socket connection\n"
756 5824d651 blueswir1
    "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port]\n"
757 5824d651 blueswir1
    "                connect the vlan 'n' to multicast maddr and port\n"
758 5824d651 blueswir1
#ifdef CONFIG_VDE
759 5824d651 blueswir1
    "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n"
760 5824d651 blueswir1
    "                connect the vlan 'n' to port 'n' of a vde switch running\n"
761 5824d651 blueswir1
    "                on host and listening for incoming connections on 'socketpath'.\n"
762 5824d651 blueswir1
    "                Use group 'groupname' and mode 'octalmode' to change default\n"
763 5824d651 blueswir1
    "                ownership and permissions for communication port.\n"
764 5824d651 blueswir1
#endif
765 bb9ea79e aliguori
    "-net dump[,vlan=n][,file=f][,len=n]\n"
766 bb9ea79e aliguori
    "                dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n"
767 5824d651 blueswir1
    "-net none       use it alone to have zero network devices; if no -net option\n"
768 5824d651 blueswir1
    "                is provided, the default is '-net nic -net user'\n")
769 5824d651 blueswir1
STEXI
770 5824d651 blueswir1
@item -net nic[,vlan=@var{n}][,macaddr=@var{addr}][,model=@var{type}][,name=@var{name}]
771 5824d651 blueswir1
Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
772 5824d651 blueswir1
= 0 is the default). The NIC is an ne2k_pci by default on the PC
773 5824d651 blueswir1
target. Optionally, the MAC address can be changed to @var{addr}
774 5824d651 blueswir1
and a @var{name} can be assigned for use in monitor commands. If no
775 5824d651 blueswir1
@option{-net} option is specified, a single NIC is created.
776 5824d651 blueswir1
Qemu can emulate several different models of network card.
777 5824d651 blueswir1
Valid values for @var{type} are
778 5824d651 blueswir1
@code{i82551}, @code{i82557b}, @code{i82559er},
779 5824d651 blueswir1
@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
780 5824d651 blueswir1
@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
781 5824d651 blueswir1
Not all devices are supported on all targets.  Use -net nic,model=?
782 5824d651 blueswir1
for a list of available devices for your target.
783 5824d651 blueswir1
784 5824d651 blueswir1
@item -net user[,vlan=@var{n}][,hostname=@var{name}][,name=@var{name}]
785 5824d651 blueswir1
Use the user mode network stack which requires no administrator
786 5824d651 blueswir1
privilege to run.  @option{hostname=name} can be used to specify the client
787 5824d651 blueswir1
hostname reported by the builtin DHCP server.
788 5824d651 blueswir1
789 5824d651 blueswir1
@item -net channel,@var{port}:@var{dev}
790 5824d651 blueswir1
Forward @option{user} TCP connection to port @var{port} to character device @var{dev}
791 5824d651 blueswir1
792 5824d651 blueswir1
@item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}]
793 5824d651 blueswir1
Connect the host TAP network interface @var{name} to VLAN @var{n}, use
794 5824d651 blueswir1
the network script @var{file} to configure it and the network script
795 5824d651 blueswir1
@var{dfile} to deconfigure it. If @var{name} is not provided, the OS
796 5824d651 blueswir1
automatically provides one. @option{fd}=@var{h} can be used to specify
797 5824d651 blueswir1
the handle of an already opened host TAP interface. The default network
798 5824d651 blueswir1
configure script is @file{/etc/qemu-ifup} and the default network
799 5824d651 blueswir1
deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no}
800 5824d651 blueswir1
or @option{downscript=no} to disable script execution. Example:
801 5824d651 blueswir1
802 5824d651 blueswir1
@example
803 5824d651 blueswir1
qemu linux.img -net nic -net tap
804 5824d651 blueswir1
@end example
805 5824d651 blueswir1
806 5824d651 blueswir1
More complicated example (two NICs, each one connected to a TAP device)
807 5824d651 blueswir1
@example
808 5824d651 blueswir1
qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
809 5824d651 blueswir1
               -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
810 5824d651 blueswir1
@end example
811 5824d651 blueswir1
812 5824d651 blueswir1
@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
813 5824d651 blueswir1
814 5824d651 blueswir1
Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
815 5824d651 blueswir1
machine using a TCP socket connection. If @option{listen} is
816 5824d651 blueswir1
specified, QEMU waits for incoming connections on @var{port}
817 5824d651 blueswir1
(@var{host} is optional). @option{connect} is used to connect to
818 5824d651 blueswir1
another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
819 5824d651 blueswir1
specifies an already opened TCP socket.
820 5824d651 blueswir1
821 5824d651 blueswir1
Example:
822 5824d651 blueswir1
@example
823 5824d651 blueswir1
# launch a first QEMU instance
824 5824d651 blueswir1
qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
825 5824d651 blueswir1
               -net socket,listen=:1234
826 5824d651 blueswir1
# connect the VLAN 0 of this instance to the VLAN 0
827 5824d651 blueswir1
# of the first instance
828 5824d651 blueswir1
qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
829 5824d651 blueswir1
               -net socket,connect=127.0.0.1:1234
830 5824d651 blueswir1
@end example
831 5824d651 blueswir1
832 5824d651 blueswir1
@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}]
833 5824d651 blueswir1
834 5824d651 blueswir1
Create a VLAN @var{n} shared with another QEMU virtual
835 5824d651 blueswir1
machines using a UDP multicast socket, effectively making a bus for
836 5824d651 blueswir1
every QEMU with same multicast address @var{maddr} and @var{port}.
837 5824d651 blueswir1
NOTES:
838 5824d651 blueswir1
@enumerate
839 5824d651 blueswir1
@item
840 5824d651 blueswir1
Several QEMU can be running on different hosts and share same bus (assuming
841 5824d651 blueswir1
correct multicast setup for these hosts).
842 5824d651 blueswir1
@item
843 5824d651 blueswir1
mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
844 5824d651 blueswir1
@url{http://user-mode-linux.sf.net}.
845 5824d651 blueswir1
@item
846 5824d651 blueswir1
Use @option{fd=h} to specify an already opened UDP multicast socket.
847 5824d651 blueswir1
@end enumerate
848 5824d651 blueswir1
849 5824d651 blueswir1
Example:
850 5824d651 blueswir1
@example
851 5824d651 blueswir1
# launch one QEMU instance
852 5824d651 blueswir1
qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
853 5824d651 blueswir1
               -net socket,mcast=230.0.0.1:1234
854 5824d651 blueswir1
# launch another QEMU instance on same "bus"
855 5824d651 blueswir1
qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
856 5824d651 blueswir1
               -net socket,mcast=230.0.0.1:1234
857 5824d651 blueswir1
# launch yet another QEMU instance on same "bus"
858 5824d651 blueswir1
qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
859 5824d651 blueswir1
               -net socket,mcast=230.0.0.1:1234
860 5824d651 blueswir1
@end example
861 5824d651 blueswir1
862 5824d651 blueswir1
Example (User Mode Linux compat.):
863 5824d651 blueswir1
@example
864 5824d651 blueswir1
# launch QEMU instance (note mcast address selected
865 5824d651 blueswir1
# is UML's default)
866 5824d651 blueswir1
qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
867 5824d651 blueswir1
               -net socket,mcast=239.192.168.1:1102
868 5824d651 blueswir1
# launch UML
869 5824d651 blueswir1
/path/to/linux ubd0=/path/to/root_fs eth0=mcast
870 5824d651 blueswir1
@end example
871 5824d651 blueswir1
872 5824d651 blueswir1
@item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
873 5824d651 blueswir1
Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
874 5824d651 blueswir1
listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
875 5824d651 blueswir1
and MODE @var{octalmode} to change default ownership and permissions for
876 5824d651 blueswir1
communication port. This option is available only if QEMU has been compiled
877 5824d651 blueswir1
with vde support enabled.
878 5824d651 blueswir1
879 5824d651 blueswir1
Example:
880 5824d651 blueswir1
@example
881 5824d651 blueswir1
# launch vde switch
882 5824d651 blueswir1
vde_switch -F -sock /tmp/myswitch
883 5824d651 blueswir1
# launch QEMU instance
884 5824d651 blueswir1
qemu linux.img -net nic -net vde,sock=/tmp/myswitch
885 5824d651 blueswir1
@end example
886 5824d651 blueswir1
887 bb9ea79e aliguori
@item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
888 bb9ea79e aliguori
Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
889 bb9ea79e aliguori
At most @var{len} bytes (64k by default) per packet are stored. The file format is
890 bb9ea79e aliguori
libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
891 bb9ea79e aliguori
892 5824d651 blueswir1
@item -net none
893 5824d651 blueswir1
Indicate that no network devices should be configured. It is used to
894 5824d651 blueswir1
override the default configuration (@option{-net nic -net user}) which
895 5824d651 blueswir1
is activated if no @option{-net} options are provided.
896 5824d651 blueswir1
ETEXI
897 5824d651 blueswir1
898 5824d651 blueswir1
#ifdef CONFIG_SLIRP
899 5824d651 blueswir1
DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, \
900 5824d651 blueswir1
    "-tftp dir       allow tftp access to files in dir [-net user]\n")
901 5824d651 blueswir1
#endif
902 5824d651 blueswir1
STEXI
903 5824d651 blueswir1
@item -tftp @var{dir}
904 5824d651 blueswir1
When using the user mode network stack, activate a built-in TFTP
905 5824d651 blueswir1
server. The files in @var{dir} will be exposed as the root of a TFTP server.
906 5824d651 blueswir1
The TFTP client on the guest must be configured in binary mode (use the command
907 5824d651 blueswir1
@code{bin} of the Unix TFTP client). The host IP address on the guest is as
908 5824d651 blueswir1
usual 10.0.2.2.
909 5824d651 blueswir1
ETEXI
910 5824d651 blueswir1
911 5824d651 blueswir1
#ifdef CONFIG_SLIRP
912 5824d651 blueswir1
DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, \
913 5824d651 blueswir1
    "-bootp file     advertise file in BOOTP replies\n")
914 5824d651 blueswir1
#endif
915 5824d651 blueswir1
STEXI
916 5824d651 blueswir1
@item -bootp @var{file}
917 5824d651 blueswir1
When using the user mode network stack, broadcast @var{file} as the BOOTP
918 5824d651 blueswir1
filename.  In conjunction with @option{-tftp}, this can be used to network boot
919 5824d651 blueswir1
a guest from a local directory.
920 5824d651 blueswir1
921 5824d651 blueswir1
Example (using pxelinux):
922 5824d651 blueswir1
@example
923 5824d651 blueswir1
qemu -hda linux.img -boot n -tftp /path/to/tftp/files -bootp /pxelinux.0
924 5824d651 blueswir1
@end example
925 5824d651 blueswir1
ETEXI
926 5824d651 blueswir1
927 5824d651 blueswir1
#ifndef _WIN32
928 5824d651 blueswir1
DEF("smb", HAS_ARG, QEMU_OPTION_smb, \
929 5824d651 blueswir1
           "-smb dir        allow SMB access to files in 'dir' [-net user]\n")
930 5824d651 blueswir1
#endif
931 5824d651 blueswir1
STEXI
932 5824d651 blueswir1
@item -smb @var{dir}
933 5824d651 blueswir1
When using the user mode network stack, activate a built-in SMB
934 5824d651 blueswir1
server so that Windows OSes can access to the host files in @file{@var{dir}}
935 5824d651 blueswir1
transparently.
936 5824d651 blueswir1
937 5824d651 blueswir1
In the guest Windows OS, the line:
938 5824d651 blueswir1
@example
939 5824d651 blueswir1
10.0.2.4 smbserver
940 5824d651 blueswir1
@end example
941 5824d651 blueswir1
must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
942 5824d651 blueswir1
or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
943 5824d651 blueswir1
944 5824d651 blueswir1
Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
945 5824d651 blueswir1
946 5824d651 blueswir1
Note that a SAMBA server must be installed on the host OS in
947 5824d651 blueswir1
@file{/usr/sbin/smbd}. QEMU was tested successfully with smbd version
948 5824d651 blueswir1
2.2.7a from the Red Hat 9 and version 3.0.10-1.fc3 from Fedora Core 3.
949 5824d651 blueswir1
ETEXI
950 5824d651 blueswir1
951 5824d651 blueswir1
#ifdef CONFIG_SLIRP
952 5824d651 blueswir1
DEF("redir", HAS_ARG, QEMU_OPTION_redir, \
953 5824d651 blueswir1
    "-redir [tcp|udp]:host-port:[guest-host]:guest-port\n" \
954 5824d651 blueswir1
    "                redirect TCP or UDP connections from host to guest [-net user]\n")
955 5824d651 blueswir1
#endif
956 5824d651 blueswir1
STEXI
957 5824d651 blueswir1
@item -redir [tcp|udp]:@var{host-port}:[@var{guest-host}]:@var{guest-port}
958 5824d651 blueswir1
959 5824d651 blueswir1
When using the user mode network stack, redirect incoming TCP or UDP
960 5824d651 blueswir1
connections to the host port @var{host-port} to the guest
961 5824d651 blueswir1
@var{guest-host} on guest port @var{guest-port}. If @var{guest-host}
962 5824d651 blueswir1
is not specified, its value is 10.0.2.15 (default address given by the
963 d4ebe193 aliguori
built-in DHCP server). If no connection type is specified, TCP is used.
964 5824d651 blueswir1
965 5824d651 blueswir1
For example, to redirect host X11 connection from screen 1 to guest
966 5824d651 blueswir1
screen 0, use the following:
967 5824d651 blueswir1
968 5824d651 blueswir1
@example
969 5824d651 blueswir1
# on the host
970 5824d651 blueswir1
qemu -redir tcp:6001::6000 [...]
971 5824d651 blueswir1
# this host xterm should open in the guest X11 server
972 5824d651 blueswir1
xterm -display :1
973 5824d651 blueswir1
@end example
974 5824d651 blueswir1
975 5824d651 blueswir1
To redirect telnet connections from host port 5555 to telnet port on
976 5824d651 blueswir1
the guest, use the following:
977 5824d651 blueswir1
978 5824d651 blueswir1
@example
979 5824d651 blueswir1
# on the host
980 5824d651 blueswir1
qemu -redir tcp:5555::23 [...]
981 5824d651 blueswir1
telnet localhost 5555
982 5824d651 blueswir1
@end example
983 5824d651 blueswir1
984 5824d651 blueswir1
Then when you use on the host @code{telnet localhost 5555}, you
985 5824d651 blueswir1
connect to the guest telnet server.
986 5824d651 blueswir1
987 5824d651 blueswir1
@end table
988 5824d651 blueswir1
ETEXI
989 5824d651 blueswir1
990 5824d651 blueswir1
DEF("bt", HAS_ARG, QEMU_OPTION_bt, \
991 5824d651 blueswir1
    "\n" \
992 5824d651 blueswir1
    "-bt hci,null    dumb bluetooth HCI - doesn't respond to commands\n" \
993 5824d651 blueswir1
    "-bt hci,host[:id]\n" \
994 5824d651 blueswir1
    "                use host's HCI with the given name\n" \
995 5824d651 blueswir1
    "-bt hci[,vlan=n]\n" \
996 5824d651 blueswir1
    "                emulate a standard HCI in virtual scatternet 'n'\n" \
997 5824d651 blueswir1
    "-bt vhci[,vlan=n]\n" \
998 5824d651 blueswir1
    "                add host computer to virtual scatternet 'n' using VHCI\n" \
999 5824d651 blueswir1
    "-bt device:dev[,vlan=n]\n" \
1000 5824d651 blueswir1
    "                emulate a bluetooth device 'dev' in scatternet 'n'\n")
1001 5824d651 blueswir1
STEXI
1002 5824d651 blueswir1
Bluetooth(R) options:
1003 5824d651 blueswir1
@table @option
1004 5824d651 blueswir1
1005 5824d651 blueswir1
@item -bt hci[...]
1006 5824d651 blueswir1
Defines the function of the corresponding Bluetooth HCI.  -bt options
1007 5824d651 blueswir1
are matched with the HCIs present in the chosen machine type.  For
1008 5824d651 blueswir1
example when emulating a machine with only one HCI built into it, only
1009 5824d651 blueswir1
the first @code{-bt hci[...]} option is valid and defines the HCI's
1010 5824d651 blueswir1
logic.  The Transport Layer is decided by the machine type.  Currently
1011 5824d651 blueswir1
the machines @code{n800} and @code{n810} have one HCI and all other
1012 5824d651 blueswir1
machines have none.
1013 5824d651 blueswir1
1014 5824d651 blueswir1
@anchor{bt-hcis}
1015 5824d651 blueswir1
The following three types are recognized:
1016 5824d651 blueswir1
1017 5824d651 blueswir1
@table @code
1018 5824d651 blueswir1
@item -bt hci,null
1019 5824d651 blueswir1
(default) The corresponding Bluetooth HCI assumes no internal logic
1020 5824d651 blueswir1
and will not respond to any HCI commands or emit events.
1021 5824d651 blueswir1
1022 5824d651 blueswir1
@item -bt hci,host[:@var{id}]
1023 5824d651 blueswir1
(@code{bluez} only) The corresponding HCI passes commands / events
1024 5824d651 blueswir1
to / from the physical HCI identified by the name @var{id} (default:
1025 5824d651 blueswir1
@code{hci0}) on the computer running QEMU.  Only available on @code{bluez}
1026 5824d651 blueswir1
capable systems like Linux.
1027 5824d651 blueswir1
1028 5824d651 blueswir1
@item -bt hci[,vlan=@var{n}]
1029 5824d651 blueswir1
Add a virtual, standard HCI that will participate in the Bluetooth
1030 5824d651 blueswir1
scatternet @var{n} (default @code{0}).  Similarly to @option{-net}
1031 5824d651 blueswir1
VLANs, devices inside a bluetooth network @var{n} can only communicate
1032 5824d651 blueswir1
with other devices in the same network (scatternet).
1033 5824d651 blueswir1
@end table
1034 5824d651 blueswir1
1035 5824d651 blueswir1
@item -bt vhci[,vlan=@var{n}]
1036 5824d651 blueswir1
(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
1037 5824d651 blueswir1
to the host bluetooth stack instead of to the emulated target.  This
1038 5824d651 blueswir1
allows the host and target machines to participate in a common scatternet
1039 5824d651 blueswir1
and communicate.  Requires the Linux @code{vhci} driver installed.  Can
1040 5824d651 blueswir1
be used as following:
1041 5824d651 blueswir1
1042 5824d651 blueswir1
@example
1043 5824d651 blueswir1
qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
1044 5824d651 blueswir1
@end example
1045 5824d651 blueswir1
1046 5824d651 blueswir1
@item -bt device:@var{dev}[,vlan=@var{n}]
1047 5824d651 blueswir1
Emulate a bluetooth device @var{dev} and place it in network @var{n}
1048 5824d651 blueswir1
(default @code{0}).  QEMU can only emulate one type of bluetooth devices
1049 5824d651 blueswir1
currently:
1050 5824d651 blueswir1
1051 5824d651 blueswir1
@table @code
1052 5824d651 blueswir1
@item keyboard
1053 5824d651 blueswir1
Virtual wireless keyboard implementing the HIDP bluetooth profile.
1054 5824d651 blueswir1
@end table
1055 5824d651 blueswir1
@end table
1056 5824d651 blueswir1
ETEXI
1057 5824d651 blueswir1
1058 5824d651 blueswir1
DEFHEADING()
1059 5824d651 blueswir1
1060 5824d651 blueswir1
DEFHEADING(Linux boot specific:)
1061 5824d651 blueswir1
STEXI
1062 5824d651 blueswir1
When using these options, you can use a given
1063 5824d651 blueswir1
Linux kernel without installing it in the disk image. It can be useful
1064 5824d651 blueswir1
for easier testing of various kernels.
1065 5824d651 blueswir1
1066 5824d651 blueswir1
@table @option
1067 5824d651 blueswir1
ETEXI
1068 5824d651 blueswir1
1069 5824d651 blueswir1
DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \
1070 5824d651 blueswir1
    "-kernel bzImage use 'bzImage' as kernel image\n")
1071 5824d651 blueswir1
STEXI
1072 5824d651 blueswir1
@item -kernel @var{bzImage}
1073 5824d651 blueswir1
Use @var{bzImage} as kernel image.
1074 5824d651 blueswir1
ETEXI
1075 5824d651 blueswir1
1076 5824d651 blueswir1
DEF("append", HAS_ARG, QEMU_OPTION_append, \
1077 5824d651 blueswir1
    "-append cmdline use 'cmdline' as kernel command line\n")
1078 5824d651 blueswir1
STEXI
1079 5824d651 blueswir1
@item -append @var{cmdline}
1080 5824d651 blueswir1
Use @var{cmdline} as kernel command line
1081 5824d651 blueswir1
ETEXI
1082 5824d651 blueswir1
1083 5824d651 blueswir1
DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \
1084 5824d651 blueswir1
           "-initrd file    use 'file' as initial ram disk\n")
1085 5824d651 blueswir1
STEXI
1086 5824d651 blueswir1
@item -initrd @var{file}
1087 5824d651 blueswir1
Use @var{file} as initial ram disk.
1088 5824d651 blueswir1
ETEXI
1089 5824d651 blueswir1
1090 5824d651 blueswir1
STEXI
1091 5824d651 blueswir1
@end table
1092 5824d651 blueswir1
ETEXI
1093 5824d651 blueswir1
1094 5824d651 blueswir1
DEFHEADING()
1095 5824d651 blueswir1
1096 5824d651 blueswir1
DEFHEADING(Debug/Expert options:)
1097 5824d651 blueswir1
1098 5824d651 blueswir1
STEXI
1099 5824d651 blueswir1
@table @option
1100 5824d651 blueswir1
ETEXI
1101 5824d651 blueswir1
1102 5824d651 blueswir1
DEF("serial", HAS_ARG, QEMU_OPTION_serial, \
1103 5824d651 blueswir1
    "-serial dev     redirect the serial port to char device 'dev'\n")
1104 5824d651 blueswir1
STEXI
1105 5824d651 blueswir1
@item -serial @var{dev}
1106 5824d651 blueswir1
Redirect the virtual serial port to host character device
1107 5824d651 blueswir1
@var{dev}. The default device is @code{vc} in graphical mode and
1108 5824d651 blueswir1
@code{stdio} in non graphical mode.
1109 5824d651 blueswir1
1110 5824d651 blueswir1
This option can be used several times to simulate up to 4 serial
1111 5824d651 blueswir1
ports.
1112 5824d651 blueswir1
1113 5824d651 blueswir1
Use @code{-serial none} to disable all serial ports.
1114 5824d651 blueswir1
1115 5824d651 blueswir1
Available character devices are:
1116 5824d651 blueswir1
@table @code
1117 5824d651 blueswir1
@item vc[:WxH]
1118 5824d651 blueswir1
Virtual console. Optionally, a width and height can be given in pixel with
1119 5824d651 blueswir1
@example
1120 5824d651 blueswir1
vc:800x600
1121 5824d651 blueswir1
@end example
1122 5824d651 blueswir1
It is also possible to specify width or height in characters:
1123 5824d651 blueswir1
@example
1124 5824d651 blueswir1
vc:80Cx24C
1125 5824d651 blueswir1
@end example
1126 5824d651 blueswir1
@item pty
1127 5824d651 blueswir1
[Linux only] Pseudo TTY (a new PTY is automatically allocated)
1128 5824d651 blueswir1
@item none
1129 5824d651 blueswir1
No device is allocated.
1130 5824d651 blueswir1
@item null
1131 5824d651 blueswir1
void device
1132 5824d651 blueswir1
@item /dev/XXX
1133 5824d651 blueswir1
[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
1134 5824d651 blueswir1
parameters are set according to the emulated ones.
1135 5824d651 blueswir1
@item /dev/parport@var{N}
1136 5824d651 blueswir1
[Linux only, parallel port only] Use host parallel port
1137 5824d651 blueswir1
@var{N}. Currently SPP and EPP parallel port features can be used.
1138 5824d651 blueswir1
@item file:@var{filename}
1139 5824d651 blueswir1
Write output to @var{filename}. No character can be read.
1140 5824d651 blueswir1
@item stdio
1141 5824d651 blueswir1
[Unix only] standard input/output
1142 5824d651 blueswir1
@item pipe:@var{filename}
1143 5824d651 blueswir1
name pipe @var{filename}
1144 5824d651 blueswir1
@item COM@var{n}
1145 5824d651 blueswir1
[Windows only] Use host serial port @var{n}
1146 5824d651 blueswir1
@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
1147 5824d651 blueswir1
This implements UDP Net Console.
1148 5824d651 blueswir1
When @var{remote_host} or @var{src_ip} are not specified
1149 5824d651 blueswir1
they default to @code{0.0.0.0}.
1150 5824d651 blueswir1
When not using a specified @var{src_port} a random port is automatically chosen.
1151 5824d651 blueswir1
@item msmouse
1152 5824d651 blueswir1
Three button serial mouse. Configure the guest to use Microsoft protocol.
1153 5824d651 blueswir1
1154 5824d651 blueswir1
If you just want a simple readonly console you can use @code{netcat} or
1155 5824d651 blueswir1
@code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
1156 5824d651 blueswir1
@code{nc -u -l -p 4555}. Any time qemu writes something to that port it
1157 5824d651 blueswir1
will appear in the netconsole session.
1158 5824d651 blueswir1
1159 5824d651 blueswir1
If you plan to send characters back via netconsole or you want to stop
1160 5824d651 blueswir1
and start qemu a lot of times, you should have qemu use the same
1161 5824d651 blueswir1
source port each time by using something like @code{-serial
1162 5824d651 blueswir1
udp::4555@@:4556} to qemu. Another approach is to use a patched
1163 5824d651 blueswir1
version of netcat which can listen to a TCP port and send and receive
1164 5824d651 blueswir1
characters via udp.  If you have a patched version of netcat which
1165 5824d651 blueswir1
activates telnet remote echo and single char transfer, then you can
1166 5824d651 blueswir1
use the following options to step up a netcat redirector to allow
1167 5824d651 blueswir1
telnet on port 5555 to access the qemu port.
1168 5824d651 blueswir1
@table @code
1169 5824d651 blueswir1
@item Qemu Options:
1170 5824d651 blueswir1
-serial udp::4555@@:4556
1171 5824d651 blueswir1
@item netcat options:
1172 5824d651 blueswir1
-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
1173 5824d651 blueswir1
@item telnet options:
1174 5824d651 blueswir1
localhost 5555
1175 5824d651 blueswir1
@end table
1176 5824d651 blueswir1
1177 5824d651 blueswir1
@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
1178 5824d651 blueswir1
The TCP Net Console has two modes of operation.  It can send the serial
1179 5824d651 blueswir1
I/O to a location or wait for a connection from a location.  By default
1180 5824d651 blueswir1
the TCP Net Console is sent to @var{host} at the @var{port}.  If you use
1181 5824d651 blueswir1
the @var{server} option QEMU will wait for a client socket application
1182 5824d651 blueswir1
to connect to the port before continuing, unless the @code{nowait}
1183 5824d651 blueswir1
option was specified.  The @code{nodelay} option disables the Nagle buffering
1184 5824d651 blueswir1
algorithm.  If @var{host} is omitted, 0.0.0.0 is assumed. Only
1185 5824d651 blueswir1
one TCP connection at a time is accepted. You can use @code{telnet} to
1186 5824d651 blueswir1
connect to the corresponding character device.
1187 5824d651 blueswir1
@table @code
1188 5824d651 blueswir1
@item Example to send tcp console to 192.168.0.2 port 4444
1189 5824d651 blueswir1
-serial tcp:192.168.0.2:4444
1190 5824d651 blueswir1
@item Example to listen and wait on port 4444 for connection
1191 5824d651 blueswir1
-serial tcp::4444,server
1192 5824d651 blueswir1
@item Example to not wait and listen on ip 192.168.0.100 port 4444
1193 5824d651 blueswir1
-serial tcp:192.168.0.100:4444,server,nowait
1194 5824d651 blueswir1
@end table
1195 5824d651 blueswir1
1196 5824d651 blueswir1
@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
1197 5824d651 blueswir1
The telnet protocol is used instead of raw tcp sockets.  The options
1198 5824d651 blueswir1
work the same as if you had specified @code{-serial tcp}.  The
1199 5824d651 blueswir1
difference is that the port acts like a telnet server or client using
1200 5824d651 blueswir1
telnet option negotiation.  This will also allow you to send the
1201 5824d651 blueswir1
MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
1202 5824d651 blueswir1
sequence.  Typically in unix telnet you do it with Control-] and then
1203 5824d651 blueswir1
type "send break" followed by pressing the enter key.
1204 5824d651 blueswir1
1205 5824d651 blueswir1
@item unix:@var{path}[,server][,nowait]
1206 5824d651 blueswir1
A unix domain socket is used instead of a tcp socket.  The option works the
1207 5824d651 blueswir1
same as if you had specified @code{-serial tcp} except the unix domain socket
1208 5824d651 blueswir1
@var{path} is used for connections.
1209 5824d651 blueswir1
1210 5824d651 blueswir1
@item mon:@var{dev_string}
1211 5824d651 blueswir1
This is a special option to allow the monitor to be multiplexed onto
1212 5824d651 blueswir1
another serial port.  The monitor is accessed with key sequence of
1213 5824d651 blueswir1
@key{Control-a} and then pressing @key{c}. See monitor access
1214 5824d651 blueswir1
@ref{pcsys_keys} in the -nographic section for more keys.
1215 5824d651 blueswir1
@var{dev_string} should be any one of the serial devices specified
1216 5824d651 blueswir1
above.  An example to multiplex the monitor onto a telnet server
1217 5824d651 blueswir1
listening on port 4444 would be:
1218 5824d651 blueswir1
@table @code
1219 5824d651 blueswir1
@item -serial mon:telnet::4444,server,nowait
1220 5824d651 blueswir1
@end table
1221 5824d651 blueswir1
1222 5824d651 blueswir1
@item braille
1223 5824d651 blueswir1
Braille device.  This will use BrlAPI to display the braille output on a real
1224 5824d651 blueswir1
or fake device.
1225 5824d651 blueswir1
1226 5824d651 blueswir1
@end table
1227 5824d651 blueswir1
ETEXI
1228 5824d651 blueswir1
1229 5824d651 blueswir1
DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \
1230 5824d651 blueswir1
    "-parallel dev   redirect the parallel port to char device 'dev'\n")
1231 5824d651 blueswir1
STEXI
1232 5824d651 blueswir1
@item -parallel @var{dev}
1233 5824d651 blueswir1
Redirect the virtual parallel port to host device @var{dev} (same
1234 5824d651 blueswir1
devices as the serial port). On Linux hosts, @file{/dev/parportN} can
1235 5824d651 blueswir1
be used to use hardware devices connected on the corresponding host
1236 5824d651 blueswir1
parallel port.
1237 5824d651 blueswir1
1238 5824d651 blueswir1
This option can be used several times to simulate up to 3 parallel
1239 5824d651 blueswir1
ports.
1240 5824d651 blueswir1
1241 5824d651 blueswir1
Use @code{-parallel none} to disable all parallel ports.
1242 5824d651 blueswir1
ETEXI
1243 5824d651 blueswir1
1244 5824d651 blueswir1
DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \
1245 5824d651 blueswir1
    "-monitor dev    redirect the monitor to char device 'dev'\n")
1246 5824d651 blueswir1
STEXI
1247 5824d651 blueswir1
@item -monitor @var{dev}
1248 5824d651 blueswir1
Redirect the monitor to host device @var{dev} (same devices as the
1249 5824d651 blueswir1
serial port).
1250 5824d651 blueswir1
The default device is @code{vc} in graphical mode and @code{stdio} in
1251 5824d651 blueswir1
non graphical mode.
1252 5824d651 blueswir1
ETEXI
1253 5824d651 blueswir1
1254 5824d651 blueswir1
DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \
1255 5824d651 blueswir1
    "-pidfile file   write PID to 'file'\n")
1256 5824d651 blueswir1
STEXI
1257 5824d651 blueswir1
@item -pidfile @var{file}
1258 5824d651 blueswir1
Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
1259 5824d651 blueswir1
from a script.
1260 5824d651 blueswir1
ETEXI
1261 5824d651 blueswir1
1262 1b530a6d aurel32
DEF("singlestep", 0, QEMU_OPTION_singlestep, \
1263 1b530a6d aurel32
    "-singlestep   always run in singlestep mode\n")
1264 1b530a6d aurel32
STEXI
1265 1b530a6d aurel32
@item -singlestep
1266 1b530a6d aurel32
Run the emulation in single step mode.
1267 1b530a6d aurel32
ETEXI
1268 1b530a6d aurel32
1269 5824d651 blueswir1
DEF("S", 0, QEMU_OPTION_S, \
1270 5824d651 blueswir1
    "-S              freeze CPU at startup (use 'c' to start execution)\n")
1271 5824d651 blueswir1
STEXI
1272 5824d651 blueswir1
@item -S
1273 5824d651 blueswir1
Do not start CPU at startup (you must type 'c' in the monitor).
1274 5824d651 blueswir1
ETEXI
1275 5824d651 blueswir1
1276 59030a8c aliguori
DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \
1277 59030a8c aliguori
    "-gdb dev        wait for gdb connection on 'dev'\n")
1278 59030a8c aliguori
STEXI
1279 59030a8c aliguori
@item -gdb @var{dev}
1280 59030a8c aliguori
Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
1281 59030a8c aliguori
connections will likely be TCP-based, but also UDP, pseudo TTY, or even
1282 59030a8c aliguori
stdio are reasonable use case. The latter is allowing to start qemu from
1283 59030a8c aliguori
within gdb and establish the connection via a pipe:
1284 59030a8c aliguori
@example
1285 59030a8c aliguori
(gdb) target remote | exec qemu -gdb stdio ...
1286 59030a8c aliguori
@end example
1287 5824d651 blueswir1
ETEXI
1288 5824d651 blueswir1
1289 59030a8c aliguori
DEF("s", 0, QEMU_OPTION_s, \
1290 59030a8c aliguori
    "-s              shorthand for -gdb tcp::%s\n")
1291 5824d651 blueswir1
STEXI
1292 59030a8c aliguori
@item -s
1293 59030a8c aliguori
Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
1294 59030a8c aliguori
(@pxref{gdb_usage}).
1295 5824d651 blueswir1
ETEXI
1296 5824d651 blueswir1
1297 5824d651 blueswir1
DEF("d", HAS_ARG, QEMU_OPTION_d, \
1298 5824d651 blueswir1
    "-d item1,...    output log to %s (use -d ? for a list of log items)\n")
1299 5824d651 blueswir1
STEXI
1300 5824d651 blueswir1
@item -d
1301 5824d651 blueswir1
Output log in /tmp/qemu.log
1302 5824d651 blueswir1
ETEXI
1303 5824d651 blueswir1
1304 5824d651 blueswir1
DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \
1305 5824d651 blueswir1
    "-hdachs c,h,s[,t]\n" \
1306 5824d651 blueswir1
    "                force hard disk 0 physical geometry and the optional BIOS\n" \
1307 5824d651 blueswir1
    "                translation (t=none or lba) (usually qemu can guess them)\n")
1308 5824d651 blueswir1
STEXI
1309 5824d651 blueswir1
@item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
1310 5824d651 blueswir1
Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
1311 5824d651 blueswir1
@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
1312 5824d651 blueswir1
translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
1313 5824d651 blueswir1
all those parameters. This option is useful for old MS-DOS disk
1314 5824d651 blueswir1
images.
1315 5824d651 blueswir1
ETEXI
1316 5824d651 blueswir1
1317 5824d651 blueswir1
DEF("L", HAS_ARG, QEMU_OPTION_L, \
1318 5824d651 blueswir1
    "-L path         set the directory for the BIOS, VGA BIOS and keymaps\n")
1319 5824d651 blueswir1
STEXI
1320 5824d651 blueswir1
@item -L  @var{path}
1321 5824d651 blueswir1
Set the directory for the BIOS, VGA BIOS and keymaps.
1322 5824d651 blueswir1
ETEXI
1323 5824d651 blueswir1
1324 5824d651 blueswir1
DEF("bios", HAS_ARG, QEMU_OPTION_bios, \
1325 5824d651 blueswir1
    "-bios file      set the filename for the BIOS\n")
1326 5824d651 blueswir1
STEXI
1327 5824d651 blueswir1
@item -bios @var{file}
1328 5824d651 blueswir1
Set the filename for the BIOS.
1329 5824d651 blueswir1
ETEXI
1330 5824d651 blueswir1
1331 640f42e4 blueswir1
#ifdef CONFIG_KQEMU
1332 5824d651 blueswir1
DEF("kernel-kqemu", 0, QEMU_OPTION_kernel_kqemu, \
1333 5824d651 blueswir1
    "-kernel-kqemu   enable KQEMU full virtualization (default is user mode only)\n")
1334 5824d651 blueswir1
#endif
1335 5824d651 blueswir1
STEXI
1336 5824d651 blueswir1
@item -kernel-kqemu
1337 5824d651 blueswir1
Enable KQEMU full virtualization (default is user mode only).
1338 5824d651 blueswir1
ETEXI
1339 5824d651 blueswir1
1340 640f42e4 blueswir1
#ifdef CONFIG_KQEMU
1341 5824d651 blueswir1
DEF("no-kqemu", 0, QEMU_OPTION_no_kqemu, \
1342 5824d651 blueswir1
    "-no-kqemu       disable KQEMU kernel module usage\n")
1343 5824d651 blueswir1
#endif
1344 5824d651 blueswir1
STEXI
1345 5824d651 blueswir1
@item -no-kqemu
1346 5824d651 blueswir1
Disable KQEMU kernel module usage. KQEMU options are only available if
1347 5824d651 blueswir1
KQEMU support is enabled when compiling.
1348 5824d651 blueswir1
ETEXI
1349 5824d651 blueswir1
1350 5824d651 blueswir1
#ifdef CONFIG_KVM
1351 5824d651 blueswir1
DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \
1352 5824d651 blueswir1
    "-enable-kvm     enable KVM full virtualization support\n")
1353 5824d651 blueswir1
#endif
1354 5824d651 blueswir1
STEXI
1355 5824d651 blueswir1
@item -enable-kvm
1356 5824d651 blueswir1
Enable KVM full virtualization support. This option is only available
1357 5824d651 blueswir1
if KVM support is enabled when compiling.
1358 5824d651 blueswir1
ETEXI
1359 5824d651 blueswir1
1360 e37630ca aliguori
#ifdef CONFIG_XEN
1361 e37630ca aliguori
DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid,
1362 e37630ca aliguori
    "-xen-domid id   specify xen guest domain id\n")
1363 e37630ca aliguori
DEF("xen-create", 0, QEMU_OPTION_xen_create,
1364 e37630ca aliguori
    "-xen-create     create domain using xen hypercalls, bypassing xend\n"
1365 e37630ca aliguori
    "                warning: should not be used when xend is in use\n")
1366 e37630ca aliguori
DEF("xen-attach", 0, QEMU_OPTION_xen_attach,
1367 e37630ca aliguori
    "-xen-attach     attach to existing xen domain\n"
1368 e37630ca aliguori
    "                xend will use this when starting qemu\n")
1369 e37630ca aliguori
#endif
1370 e37630ca aliguori
1371 5824d651 blueswir1
DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \
1372 5824d651 blueswir1
    "-no-reboot      exit instead of rebooting\n")
1373 5824d651 blueswir1
STEXI
1374 5824d651 blueswir1
@item -no-reboot
1375 5824d651 blueswir1
Exit instead of rebooting.
1376 5824d651 blueswir1
ETEXI
1377 5824d651 blueswir1
1378 5824d651 blueswir1
DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \
1379 5824d651 blueswir1
    "-no-shutdown    stop before shutdown\n")
1380 5824d651 blueswir1
STEXI
1381 5824d651 blueswir1
@item -no-shutdown
1382 5824d651 blueswir1
Don't exit QEMU on guest shutdown, but instead only stop the emulation.
1383 5824d651 blueswir1
This allows for instance switching to monitor to commit changes to the
1384 5824d651 blueswir1
disk image.
1385 5824d651 blueswir1
ETEXI
1386 5824d651 blueswir1
1387 5824d651 blueswir1
DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \
1388 5824d651 blueswir1
    "-loadvm [tag|id]\n" \
1389 5824d651 blueswir1
    "                start right away with a saved state (loadvm in monitor)\n")
1390 5824d651 blueswir1
STEXI
1391 5824d651 blueswir1
@item -loadvm @var{file}
1392 5824d651 blueswir1
Start right away with a saved state (@code{loadvm} in monitor)
1393 5824d651 blueswir1
ETEXI
1394 5824d651 blueswir1
1395 5824d651 blueswir1
#ifndef _WIN32
1396 5824d651 blueswir1
DEF("daemonize", 0, QEMU_OPTION_daemonize, \
1397 5824d651 blueswir1
    "-daemonize      daemonize QEMU after initializing\n")
1398 5824d651 blueswir1
#endif
1399 5824d651 blueswir1
STEXI
1400 5824d651 blueswir1
@item -daemonize
1401 5824d651 blueswir1
Daemonize the QEMU process after initialization.  QEMU will not detach from
1402 5824d651 blueswir1
standard IO until it is ready to receive connections on any of its devices.
1403 5824d651 blueswir1
This option is a useful way for external programs to launch QEMU without having
1404 5824d651 blueswir1
to cope with initialization race conditions.
1405 5824d651 blueswir1
ETEXI
1406 5824d651 blueswir1
1407 5824d651 blueswir1
DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \
1408 5824d651 blueswir1
    "-option-rom rom load a file, rom, into the option ROM space\n")
1409 5824d651 blueswir1
STEXI
1410 5824d651 blueswir1
@item -option-rom @var{file}
1411 5824d651 blueswir1
Load the contents of @var{file} as an option ROM.
1412 5824d651 blueswir1
This option is useful to load things like EtherBoot.
1413 5824d651 blueswir1
ETEXI
1414 5824d651 blueswir1
1415 5824d651 blueswir1
DEF("clock", HAS_ARG, QEMU_OPTION_clock, \
1416 5824d651 blueswir1
    "-clock          force the use of the given methods for timer alarm.\n" \
1417 5824d651 blueswir1
    "                To see what timers are available use -clock ?\n")
1418 5824d651 blueswir1
STEXI
1419 5824d651 blueswir1
@item -clock @var{method}
1420 5824d651 blueswir1
Force the use of the given methods for timer alarm. To see what timers
1421 5824d651 blueswir1
are available use -clock ?.
1422 5824d651 blueswir1
ETEXI
1423 5824d651 blueswir1
1424 5824d651 blueswir1
DEF("localtime", 0, QEMU_OPTION_localtime, \
1425 5824d651 blueswir1
    "-localtime      set the real time clock to local time [default=utc]\n")
1426 5824d651 blueswir1
STEXI
1427 5824d651 blueswir1
@item -localtime
1428 5824d651 blueswir1
Set the real time clock to local time (the default is to UTC
1429 5824d651 blueswir1
time). This option is needed to have correct date in MS-DOS or
1430 5824d651 blueswir1
Windows.
1431 5824d651 blueswir1
ETEXI
1432 5824d651 blueswir1
1433 5824d651 blueswir1
DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, \
1434 5824d651 blueswir1
    "-startdate      select initial date of the clock\n")
1435 5824d651 blueswir1
STEXI
1436 5824d651 blueswir1
1437 5824d651 blueswir1
@item -startdate @var{date}
1438 5824d651 blueswir1
Set the initial date of the real time clock. Valid formats for
1439 5824d651 blueswir1
@var{date} are: @code{now} or @code{2006-06-17T16:01:21} or
1440 5824d651 blueswir1
@code{2006-06-17}. The default value is @code{now}.
1441 5824d651 blueswir1
ETEXI
1442 5824d651 blueswir1
1443 5824d651 blueswir1
DEF("icount", HAS_ARG, QEMU_OPTION_icount, \
1444 5824d651 blueswir1
    "-icount [N|auto]\n" \
1445 bc14ca24 aliguori
    "                enable virtual instruction counter with 2^N clock ticks per\n" \
1446 bc14ca24 aliguori
    "                instruction\n")
1447 5824d651 blueswir1
STEXI
1448 5824d651 blueswir1
@item -icount [N|auto]
1449 5824d651 blueswir1
Enable virtual instruction counter.  The virtual cpu will execute one
1450 5824d651 blueswir1
instruction every 2^N ns of virtual time.  If @code{auto} is specified
1451 5824d651 blueswir1
then the virtual cpu speed will be automatically adjusted to keep virtual
1452 5824d651 blueswir1
time within a few seconds of real time.
1453 5824d651 blueswir1
1454 5824d651 blueswir1
Note that while this option can give deterministic behavior, it does not
1455 5824d651 blueswir1
provide cycle accurate emulation.  Modern CPUs contain superscalar out of
1456 5824d651 blueswir1
order cores with complex cache hierarchies.  The number of instructions
1457 5824d651 blueswir1
executed often has little or no correlation with actual performance.
1458 5824d651 blueswir1
ETEXI
1459 5824d651 blueswir1
1460 9dd986cc Richard W.M. Jones
DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \
1461 9dd986cc Richard W.M. Jones
    "-watchdog i6300esb|ib700\n" \
1462 9dd986cc Richard W.M. Jones
    "                enable virtual hardware watchdog [default=none]\n")
1463 9dd986cc Richard W.M. Jones
STEXI
1464 9dd986cc Richard W.M. Jones
@item -watchdog @var{model}
1465 9dd986cc Richard W.M. Jones
Create a virtual hardware watchdog device.  Once enabled (by a guest
1466 9dd986cc Richard W.M. Jones
action), the watchdog must be periodically polled by an agent inside
1467 9dd986cc Richard W.M. Jones
the guest or else the guest will be restarted.
1468 9dd986cc Richard W.M. Jones
1469 9dd986cc Richard W.M. Jones
The @var{model} is the model of hardware watchdog to emulate.  Choices
1470 9dd986cc Richard W.M. Jones
for model are: @code{ib700} (iBASE 700) which is a very simple ISA
1471 9dd986cc Richard W.M. Jones
watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O
1472 9dd986cc Richard W.M. Jones
controller hub) which is a much more featureful PCI-based dual-timer
1473 9dd986cc Richard W.M. Jones
watchdog.  Choose a model for which your guest has drivers.
1474 9dd986cc Richard W.M. Jones
1475 9dd986cc Richard W.M. Jones
Use @code{-watchdog ?} to list available hardware models.  Only one
1476 9dd986cc Richard W.M. Jones
watchdog can be enabled for a guest.
1477 9dd986cc Richard W.M. Jones
ETEXI
1478 9dd986cc Richard W.M. Jones
1479 9dd986cc Richard W.M. Jones
DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \
1480 9dd986cc Richard W.M. Jones
    "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \
1481 9dd986cc Richard W.M. Jones
    "                action when watchdog fires [default=reset]\n")
1482 9dd986cc Richard W.M. Jones
STEXI
1483 9dd986cc Richard W.M. Jones
@item -watchdog-action @var{action}
1484 9dd986cc Richard W.M. Jones
1485 9dd986cc Richard W.M. Jones
The @var{action} controls what QEMU will do when the watchdog timer
1486 9dd986cc Richard W.M. Jones
expires.
1487 9dd986cc Richard W.M. Jones
The default is
1488 9dd986cc Richard W.M. Jones
@code{reset} (forcefully reset the guest).
1489 9dd986cc Richard W.M. Jones
Other possible actions are:
1490 9dd986cc Richard W.M. Jones
@code{shutdown} (attempt to gracefully shutdown the guest),
1491 9dd986cc Richard W.M. Jones
@code{poweroff} (forcefully poweroff the guest),
1492 9dd986cc Richard W.M. Jones
@code{pause} (pause the guest),
1493 9dd986cc Richard W.M. Jones
@code{debug} (print a debug message and continue), or
1494 9dd986cc Richard W.M. Jones
@code{none} (do nothing).
1495 9dd986cc Richard W.M. Jones
1496 9dd986cc Richard W.M. Jones
Note that the @code{shutdown} action requires that the guest responds
1497 9dd986cc Richard W.M. Jones
to ACPI signals, which it may not be able to do in the sort of
1498 9dd986cc Richard W.M. Jones
situations where the watchdog would have expired, and thus
1499 9dd986cc Richard W.M. Jones
@code{-watchdog-action shutdown} is not recommended for production use.
1500 9dd986cc Richard W.M. Jones
1501 9dd986cc Richard W.M. Jones
Examples:
1502 9dd986cc Richard W.M. Jones
1503 9dd986cc Richard W.M. Jones
@table @code
1504 9dd986cc Richard W.M. Jones
@item -watchdog i6300esb -watchdog-action pause
1505 9dd986cc Richard W.M. Jones
@item -watchdog ib700
1506 9dd986cc Richard W.M. Jones
@end table
1507 9dd986cc Richard W.M. Jones
ETEXI
1508 9dd986cc Richard W.M. Jones
1509 5824d651 blueswir1
DEF("echr", HAS_ARG, QEMU_OPTION_echr, \
1510 5824d651 blueswir1
    "-echr chr       set terminal escape character instead of ctrl-a\n")
1511 5824d651 blueswir1
STEXI
1512 5824d651 blueswir1
1513 5824d651 blueswir1
@item -echr numeric_ascii_value
1514 5824d651 blueswir1
Change the escape character used for switching to the monitor when using
1515 5824d651 blueswir1
monitor and serial sharing.  The default is @code{0x01} when using the
1516 5824d651 blueswir1
@code{-nographic} option.  @code{0x01} is equal to pressing
1517 5824d651 blueswir1
@code{Control-a}.  You can select a different character from the ascii
1518 5824d651 blueswir1
control keys where 1 through 26 map to Control-a through Control-z.  For
1519 5824d651 blueswir1
instance you could use the either of the following to change the escape
1520 5824d651 blueswir1
character to Control-t.
1521 5824d651 blueswir1
@table @code
1522 5824d651 blueswir1
@item -echr 0x14
1523 5824d651 blueswir1
@item -echr 20
1524 5824d651 blueswir1
@end table
1525 5824d651 blueswir1
ETEXI
1526 5824d651 blueswir1
1527 5824d651 blueswir1
DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \
1528 5824d651 blueswir1
    "-virtioconsole c\n" \
1529 5824d651 blueswir1
    "                set virtio console\n")
1530 5824d651 blueswir1
STEXI
1531 5824d651 blueswir1
@item -virtioconsole @var{c}
1532 5824d651 blueswir1
Set virtio console.
1533 5824d651 blueswir1
ETEXI
1534 5824d651 blueswir1
1535 5824d651 blueswir1
DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \
1536 5824d651 blueswir1
    "-show-cursor    show cursor\n")
1537 5824d651 blueswir1
STEXI
1538 5824d651 blueswir1
ETEXI
1539 5824d651 blueswir1
1540 5824d651 blueswir1
DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \
1541 5824d651 blueswir1
    "-tb-size n      set TB size\n")
1542 5824d651 blueswir1
STEXI
1543 5824d651 blueswir1
ETEXI
1544 5824d651 blueswir1
1545 5824d651 blueswir1
DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \
1546 5824d651 blueswir1
    "-incoming p     prepare for incoming migration, listen on port p\n")
1547 5824d651 blueswir1
STEXI
1548 5824d651 blueswir1
ETEXI
1549 5824d651 blueswir1
1550 5824d651 blueswir1
#ifndef _WIN32
1551 5824d651 blueswir1
DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \
1552 5824d651 blueswir1
    "-chroot dir     Chroot to dir just before starting the VM.\n")
1553 5824d651 blueswir1
#endif
1554 5824d651 blueswir1
STEXI
1555 5824d651 blueswir1
@item -chroot dir
1556 5824d651 blueswir1
Immediately before starting guest execution, chroot to the specified
1557 5824d651 blueswir1
directory.  Especially useful in combination with -runas.
1558 5824d651 blueswir1
ETEXI
1559 5824d651 blueswir1
1560 5824d651 blueswir1
#ifndef _WIN32
1561 5824d651 blueswir1
DEF("runas", HAS_ARG, QEMU_OPTION_runas, \
1562 5824d651 blueswir1
    "-runas user     Change to user id user just before starting the VM.\n")
1563 5824d651 blueswir1
#endif
1564 5824d651 blueswir1
STEXI
1565 5824d651 blueswir1
@item -runas user
1566 5824d651 blueswir1
Immediately before starting guest execution, drop root privileges, switching
1567 5824d651 blueswir1
to the specified user.
1568 5824d651 blueswir1
ETEXI
1569 5824d651 blueswir1
1570 5824d651 blueswir1
STEXI
1571 5824d651 blueswir1
@end table
1572 5824d651 blueswir1
ETEXI
1573 5824d651 blueswir1
1574 5824d651 blueswir1
#if defined(TARGET_SPARC) || defined(TARGET_PPC)
1575 5824d651 blueswir1
DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
1576 5824d651 blueswir1
    "-prom-env variable=value\n"
1577 5824d651 blueswir1
    "                set OpenBIOS nvram variables\n")
1578 5824d651 blueswir1
#endif
1579 5824d651 blueswir1
#if defined(TARGET_ARM) || defined(TARGET_M68K)
1580 5824d651 blueswir1
DEF("semihosting", 0, QEMU_OPTION_semihosting,
1581 5824d651 blueswir1
    "-semihosting    semihosting mode\n")
1582 5824d651 blueswir1
#endif
1583 5824d651 blueswir1
#if defined(TARGET_ARM)
1584 5824d651 blueswir1
DEF("old-param", 0, QEMU_OPTION_old_param,
1585 5824d651 blueswir1
    "-old-param      old param mode\n")
1586 5824d651 blueswir1
#endif