Revision 7544a042 qemu-doc.texi

b/qemu-doc.texi
37 37
* QEMU System emulator for non PC targets::
38 38
* QEMU User space emulator::
39 39
* compilation:: Compilation from the sources
40
* License::
40 41
* Index::
41 42
@end menu
42 43
@end ifnottex
......
59 60
QEMU has two operating modes:
60 61

  
61 62
@itemize
63
@cindex operating modes
62 64

  
63 65
@item
66
@cindex system emulation
64 67
Full system emulation. In this mode, QEMU emulates a full system (for
65 68
example a PC), including one or several processors and various
66 69
peripherals. It can be used to launch different Operating Systems
67 70
without rebooting the PC or to debug system code.
68 71

  
69 72
@item
73
@cindex user mode emulation
70 74
User mode emulation. In this mode, QEMU can launch
71 75
processes compiled for one CPU on another CPU. It can be used to
72 76
launch the Wine Windows API emulator (@url{http://www.winehq.org}) or
......
79 83

  
80 84
For system emulation, the following hardware targets are supported:
81 85
@itemize
86
@cindex emulated target systems
87
@cindex supported target systems
82 88
@item PC (x86 or x86_64 processor)
83 89
@item ISA PC (old style PC without PCI bus)
84 90
@item PREP (PowerPC processor)
......
106 112
@item Petalogix Spartan 3aDSP1800 MMU ref design (MicroBlaze).
107 113
@end itemize
108 114

  
109
For user emulation, x86, PowerPC, ARM, 32-bit MIPS, Sparc32/64, ColdFire(m68k), CRISv32 and MicroBlaze CPUs are supported.
115
@cindex supported user mode targets
116
For user emulation, x86 (32 and 64 bit), PowerPC (32 and 64 bit),
117
ARM, MIPS (32 bit only), Sparc (32 and 64 bit),
118
Alpha, ColdFire(m68k), CRISv32 and MicroBlaze CPUs are supported.
110 119

  
111 120
@node Installation
112 121
@chapter Installation
......
121 130

  
122 131
@node install_linux
123 132
@section Linux
133
@cindex installation (Linux)
124 134

  
125 135
If a precompiled package is available for your distribution - you just
126 136
have to install it. Otherwise, see @ref{compilation}.
127 137

  
128 138
@node install_windows
129 139
@section Windows
140
@cindex installation (Windows)
130 141

  
131 142
Download the experimental binary installer at
132 143
@url{http://www.free.oszoo.org/@/download.html}.
144
TODO (no longer available)
133 145

  
134 146
@node install_mac
135 147
@section Mac OS X
136 148

  
137 149
Download the experimental binary installer at
138 150
@url{http://www.free.oszoo.org/@/download.html}.
151
TODO (no longer available)
139 152

  
140 153
@node QEMU PC System emulator
141 154
@chapter QEMU PC System emulator
155
@cindex system emulation (PC)
142 156

  
143 157
@menu
144 158
* pcsys_introduction:: Introduction
......
229 243

  
230 244
@node pcsys_quickstart
231 245
@section Quick Start
246
@cindex quick start
232 247

  
233 248
Download and uncompress the linux image (@file{linux.img}) and type:
234 249

  
......
263 278
During the graphical emulation, you can use the following keys:
264 279
@table @key
265 280
@item Ctrl-Alt-f
281
@kindex Ctrl-Alt-f
266 282
Toggle full screen
267 283

  
268 284
@item Ctrl-Alt-u
285
@kindex Ctrl-Alt-u
269 286
Restore the screen's un-scaled dimensions
270 287

  
271 288
@item Ctrl-Alt-n
289
@kindex Ctrl-Alt-n
272 290
Switch to virtual console 'n'. Standard console mappings are:
273 291
@table @emph
274 292
@item 1
......
280 298
@end table
281 299

  
282 300
@item Ctrl-Alt
301
@kindex Ctrl-Alt
283 302
Toggle mouse and keyboard grab.
284 303
@end table
285 304

  
305
@kindex Ctrl-Up
306
@kindex Ctrl-Down
307
@kindex Ctrl-PageUp
308
@kindex Ctrl-PageDown
286 309
In the virtual consoles, you can use @key{Ctrl-Up}, @key{Ctrl-Down},
287 310
@key{Ctrl-PageUp} and @key{Ctrl-PageDown} to move in the back log.
288 311

  
312
@kindex Ctrl-a h
289 313
During emulation, if you are using the @option{-nographic} option, use
290 314
@key{Ctrl-a h} to get terminal commands:
291 315

  
292 316
@table @key
293 317
@item Ctrl-a h
318
@kindex Ctrl-a h
294 319
@item Ctrl-a ?
320
@kindex Ctrl-a ?
295 321
Print this help
296 322
@item Ctrl-a x
323
@kindex Ctrl-a x
297 324
Exit emulator
298 325
@item Ctrl-a s
326
@kindex Ctrl-a s
299 327
Save disk data back to file (if -snapshot)
300 328
@item Ctrl-a t
329
@kindex Ctrl-a t
301 330
Toggle console timestamps
302 331
@item Ctrl-a b
332
@kindex Ctrl-a b
303 333
Send break (magic sysrq in Linux)
304 334
@item Ctrl-a c
335
@kindex Ctrl-a c
305 336
Switch between console and monitor
306 337
@item Ctrl-a Ctrl-a
338
@kindex Ctrl-a a
307 339
Send Ctrl-a
308 340
@end table
309 341
@c man end
......
323 355

  
324 356
@node pcsys_monitor
325 357
@section QEMU Monitor
358
@cindex QEMU monitor
326 359

  
327 360
The QEMU monitor is used to give complex commands to the QEMU
328 361
emulator. You can use it to:
......
1286 1319
differences are mentioned in the following sections.
1287 1320

  
1288 1321
@menu
1289
* QEMU PowerPC System emulator::
1322
* PowerPC System emulator::
1290 1323
* Sparc32 System emulator::
1291 1324
* Sparc64 System emulator::
1292 1325
* MIPS System emulator::
1293 1326
* ARM System emulator::
1294 1327
* ColdFire System emulator::
1328
* Cris System emulator::
1329
* Microblaze System emulator::
1330
* SH4 System emulator::
1295 1331
@end menu
1296 1332

  
1297
@node QEMU PowerPC System emulator
1298
@section QEMU PowerPC System emulator
1333
@node PowerPC System emulator
1334
@section PowerPC System emulator
1335
@cindex system emulation (PowerPC)
1299 1336

  
1300 1337
Use the executable @file{qemu-system-ppc} to simulate a complete PREP
1301 1338
or PowerMac PowerPC system.
......
1378 1415

  
1379 1416
@node Sparc32 System emulator
1380 1417
@section Sparc32 System emulator
1418
@cindex system emulation (Sparc32)
1381 1419

  
1382 1420
Use the executable @file{qemu-system-sparc} to simulate the following
1383 1421
Sun4m architecture machines:
......
1476 1514

  
1477 1515
@node Sparc64 System emulator
1478 1516
@section Sparc64 System emulator
1517
@cindex system emulation (Sparc64)
1479 1518

  
1480 1519
Use the executable @file{qemu-system-sparc64} to simulate a Sun4u
1481 1520
(UltraSPARC PC-like machine), Sun4v (T1 PC-like machine), or generic
......
1525 1564

  
1526 1565
@node MIPS System emulator
1527 1566
@section MIPS System emulator
1567
@cindex system emulation (MIPS)
1528 1568

  
1529 1569
Four executables cover simulation of 32 and 64-bit MIPS systems in
1530 1570
both endian options, @file{qemu-system-mips}, @file{qemu-system-mipsel}
......
1620 1660

  
1621 1661
@node ARM System emulator
1622 1662
@section ARM System emulator
1663
@cindex system emulation (ARM)
1623 1664

  
1624 1665
Use the executable @file{qemu-system-arm} to simulate a ARM
1625 1666
machine. The ARM Integrator/CP board is emulated with the following
......
1905 1946

  
1906 1947
@node ColdFire System emulator
1907 1948
@section ColdFire System emulator
1949
@cindex system emulation (ColdFire)
1950
@cindex system emulation (M68K)
1908 1951

  
1909 1952
Use the executable @file{qemu-system-m68k} to simulate a ColdFire machine.
1910 1953
The emulator is able to boot a uClinux kernel.
......
1931 1974

  
1932 1975
@c man begin OPTIONS
1933 1976

  
1934
The following options are specific to the ARM emulation:
1977
The following options are specific to the ColdFire emulation:
1935 1978

  
1936 1979
@table @option
1937 1980

  
......
1945 1988

  
1946 1989
@end table
1947 1990

  
1991
@node Cris System emulator
1992
@section Cris System emulator
1993
@cindex system emulation (Cris)
1994

  
1995
TODO
1996

  
1997
@node Microblaze System emulator
1998
@section Microblaze System emulator
1999
@cindex system emulation (Microblaze)
2000

  
2001
TODO
2002

  
2003
@node SH4 System emulator
2004
@section SH4 System emulator
2005
@cindex system emulation (SH4)
2006

  
2007
TODO
2008

  
1948 2009
@node QEMU User space emulator
1949 2010
@chapter QEMU User space emulator
1950 2011

  
......
2109 2170
@node Other binaries
2110 2171
@subsection Other binaries
2111 2172

  
2173
@cindex user mode (Alpha)
2174
@command{qemu-alpha} TODO.
2175

  
2176
@cindex user mode (ARM)
2177
@command{qemu-armeb} TODO.
2178

  
2179
@cindex user mode (ARM)
2112 2180
@command{qemu-arm} is also capable of running ARM "Angel" semihosted ELF
2113 2181
binaries (as implemented by the arm-elf and arm-eabi Newlib/GDB
2114 2182
configurations), and arm-uclinux bFLT format binaries.
2115 2183

  
2184
@cindex user mode (ColdFire)
2185
@cindex user mode (M68K)
2116 2186
@command{qemu-m68k} is capable of running semihosted binaries using the BDM
2117 2187
(m5xxx-ram-hosted.ld) or m68k-sim (sim.ld) syscall interfaces, and
2118 2188
coldfire uClinux bFLT format binaries.
2119 2189

  
2120 2190
The binary format is detected automatically.
2121 2191

  
2192
@cindex user mode (Cris)
2193
@command{qemu-cris} TODO.
2194

  
2195
@cindex user mode (i386)
2196
@command{qemu-i386} TODO.
2197
@command{qemu-x86_64} TODO.
2198

  
2199
@cindex user mode (Microblaze)
2200
@command{qemu-microblaze} TODO.
2201

  
2202
@cindex user mode (MIPS)
2203
@command{qemu-mips} TODO.
2204
@command{qemu-mipsel} TODO.
2205

  
2206
@cindex user mode (PowerPC)
2207
@command{qemu-ppc64abi32} TODO.
2208
@command{qemu-ppc64} TODO.
2209
@command{qemu-ppc} TODO.
2210

  
2211
@cindex user mode (SH4)
2212
@command{qemu-sh4eb} TODO.
2213
@command{qemu-sh4} TODO.
2214

  
2215
@cindex user mode (SPARC)
2122 2216
@command{qemu-sparc} can execute Sparc32 binaries (Sparc32 CPU, 32 bit ABI).
2123 2217

  
2124 2218
@command{qemu-sparc32plus} can execute Sparc32 and SPARC32PLUS binaries
......
2439 2533

  
2440 2534
@end table
2441 2535

  
2536
@node License
2537
@appendix License
2538

  
2539
QEMU is a trademark of Fabrice Bellard.
2540

  
2541
QEMU is released under the GNU General Public License (TODO: add link).
2542
Parts of QEMU have specific licenses, see file LICENSE.
2543

  
2544
TODO (refer to file LICENSE, include it, include the GPL?)
2545

  
2442 2546
@node Index
2443
@chapter Index
2547
@appendix Index
2548
@menu
2549
* Concept Index::
2550
* Function Index::
2551
* Keystroke Index::
2552
* Program Index::
2553
* Data Type Index::
2554
* Variable Index::
2555
@end menu
2556

  
2557
@node Concept Index
2558
@section Concept Index
2559
This is the main index. Should we combine all keywords in one index? TODO
2444 2560
@printindex cp
2445 2561

  
2562
@node Function Index
2563
@section Function Index
2564
This index could be used for command line options and monitor functions.
2565
@printindex fn
2566

  
2567
@node Keystroke Index
2568
@section Keystroke Index
2569

  
2570
This is a list of all keystrokes which have a special function
2571
in system emulation.
2572

  
2573
@printindex ky
2574

  
2575
@node Program Index
2576
@section Program Index
2577
@printindex pg
2578

  
2579
@node Data Type Index
2580
@section Data Type Index
2581

  
2582
This index could be used for qdev device names and options.
2583

  
2584
@printindex tp
2585

  
2586
@node Variable Index
2587
@section Variable Index
2588
@printindex vr
2589

  
2446 2590
@bye

Also available in: Unified diff