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