* [Qemu-devel] [RFC] Documentation @ 2010-02-05 22:50 Stefan Weil 2010-02-05 22:51 ` [Qemu-devel] [PATCH 1/8] Documentation: Add build support for documentation in pdf format Stefan Weil 0 siblings, 1 reply; 10+ messages in thread From: Stefan Weil @ 2010-02-05 22:50 UTC (permalink / raw) To: QEMU Developers The following patches enhance the existing documentation. They contain several parts marked with TODO where information is still missing, so feedback is welcome. They also add an index, or even several of them. There are many ways to organize an index, so I need feedback here, too. Overview of patches: Documentation: Add build support for documentation in pdf format (unmodified resend) Documentation: Add direntry for info format Documentation: Use UTF-8 encoding and fix one wrong encoding Documentation: Add some basic documentation on make targets Documentation: Fix item list Documentation: Enhance documentation (index, keywords) Documentation: Add monitor commands to function index Documentation: Add command line options to function index Regards Stefan Weil ^ permalink raw reply [flat|nested] 10+ messages in thread
* [Qemu-devel] [PATCH 1/8] Documentation: Add build support for documentation in pdf format 2010-02-05 22:50 [Qemu-devel] [RFC] Documentation Stefan Weil @ 2010-02-05 22:51 ` Stefan Weil 2010-02-05 22:51 ` [Qemu-devel] [PATCH 2/8] Documentation: Add direntry for info format Stefan Weil 0 siblings, 1 reply; 10+ messages in thread From: Stefan Weil @ 2010-02-05 22:51 UTC (permalink / raw) To: QEMU Developers Makefile already supported dvi, html and info formats, but pdf was missing. pdf is especially convenient for printing and for documentation reviews. I hope it will help to improve qemu's documentation. Make now supports the new target 'pdf' which will create qemu-doc.pdf and qemu-tech.pdf. It is also possible to build both files individually. texi2pdf and texi2dvi are rather noisy, so normally some less important warnings are suppressed. When make is called with V=1 (verbose mode), warnings are not suppressed. The patch also sorts the documentation targets alphabetically and wraps a line which was too long. Signed-off-by: Stefan Weil <weil@mail.berlios.de> --- .gitignore | 1 + Makefile | 21 +++++++++++++-------- 2 files changed, 14 insertions(+), 8 deletions(-) diff --git a/.gitignore b/.gitignore index d7d2146..dfc8e5b 100644 --- a/.gitignore +++ b/.gitignore @@ -36,6 +36,7 @@ qemu-monitor.texi *.fn *.ky *.log +*.pdf *.pg *.toc *.tp diff --git a/Makefile b/Makefile index 24938db..c72a059 100644 --- a/Makefile +++ b/Makefile @@ -22,7 +22,7 @@ Makefile: ; configure: ; .PHONY: all clean cscope distclean dvi html info install install-doc \ - recurse-all speed tar tarbin test build-all + pdf recurse-all speed tar tarbin test build-all $(call set-vpath, $(SRC_PATH):$(SRC_PATH)/hw) @@ -160,7 +160,7 @@ distclean: clean rm -f config-host.mak config-host.h* config-host.ld $(DOCS) qemu-options.texi qemu-img-cmds.texi qemu-monitor.texi rm -f config-all-devices.mak rm -f roms/seabios/config.mak roms/vgabios/config.mak - rm -f qemu-{doc,tech}.{info,aux,cp,dvi,fn,info,ky,log,pg,toc,tp,vr} + rm -f qemu-{doc,tech}.{info,aux,cp,dvi,fn,info,ky,log,pdf,pg,toc,tp,vr} for d in $(TARGET_DIRS) libhw32 libhw64 libuser; do \ rm -rf $$d || exit 1 ; \ done @@ -224,14 +224,18 @@ cscope: cscope -b # documentation +TEXIFLAG=$(if $(V),,--quiet) +%.dvi: %.texi + $(call quiet-command,texi2dvi $(TEXIFLAG) -I . $<," GEN $@") + %.html: %.texi $(call quiet-command,texi2html -I=. -monolithic -number $<," GEN $@") %.info: %.texi $(call quiet-command,makeinfo -I . $< -o $@," GEN $@") -%.dvi: %.texi - $(call quiet-command,texi2dvi -I . $<," GEN $@") +%.pdf: %.texi + $(call quiet-command,texi2pdf $(TEXIFLAG) -I . $<," GEN $@") qemu-options.texi: $(SRC_PATH)/qemu-options.hx $(call quiet-command,sh $(SRC_PATH)/hxtool -t < $< > $@," GEN $@") @@ -260,13 +264,14 @@ qemu-nbd.8: qemu-nbd.texi pod2man --section=8 --center=" " --release=" " qemu-nbd.pod > $@, \ " GEN $@") -info: qemu-doc.info qemu-tech.info - dvi: qemu-doc.dvi qemu-tech.dvi - html: qemu-doc.html qemu-tech.html +info: qemu-doc.info qemu-tech.info +pdf: qemu-doc.pdf qemu-tech.pdf -qemu-doc.dvi qemu-doc.html qemu-doc.info: qemu-img.texi qemu-nbd.texi qemu-options.texi qemu-monitor.texi qemu-img-cmds.texi +qemu-doc.dvi qemu-doc.html qemu-doc.info qemu-doc.pdf: \ + qemu-img.texi qemu-nbd.texi qemu-options.texi \ + qemu-monitor.texi qemu-img-cmds.texi VERSION ?= $(shell cat VERSION) FILE = qemu-$(VERSION) -- 1.6.5 ^ permalink raw reply related [flat|nested] 10+ messages in thread
* [Qemu-devel] [PATCH 2/8] Documentation: Add direntry for info format 2010-02-05 22:51 ` [Qemu-devel] [PATCH 1/8] Documentation: Add build support for documentation in pdf format Stefan Weil @ 2010-02-05 22:51 ` Stefan Weil 2010-02-05 22:52 ` [Qemu-devel] [PATCH 3/8] Documentation: Use UTF-8 encoding and fix one wrong encoding Stefan Weil 2010-02-10 19:30 ` [Qemu-devel] [PATCH 2/8] Documentation: Add direntry for info format Anthony Liguori 0 siblings, 2 replies; 10+ messages in thread From: Stefan Weil @ 2010-02-05 22:51 UTC (permalink / raw) To: QEMU Developers update-info-dir maintains an index of all available documentation in info format (the file /usr/share/info/dir). It reads special @direntry tags in info files. This patch (extracted from a larger patch provided by Dirk Ullrich) adds these tags for qemu-doc.info and qemu-tech.info. Signed-off-by: Stefan Weil <weil@mail.berlios.de> --- qemu-doc.texi | 6 ++++++ qemu-tech.texi | 6 ++++++ 2 files changed, 12 insertions(+), 0 deletions(-) diff --git a/qemu-doc.texi b/qemu-doc.texi index 2fb5c0b..eba6437 100644 --- a/qemu-doc.texi +++ b/qemu-doc.texi @@ -6,6 +6,12 @@ @paragraphindent 0 @c %**end of header +@ifinfo +@direntry +* QEMU: (qemu-doc). The QEMU Emulator User Documentation. +@end direntry +@end ifinfo + @iftex @titlepage @sp 7 diff --git a/qemu-tech.texi b/qemu-tech.texi index 97d8dea..52560dc 100644 --- a/qemu-tech.texi +++ b/qemu-tech.texi @@ -6,6 +6,12 @@ @paragraphindent 0 @c %**end of header +@ifinfo +@direntry +* QEMU Internals: (qemu-tech). The QEMU Emulator Internals. +@end direntry +@end ifinfo + @iftex @titlepage @sp 7 -- 1.6.5 ^ permalink raw reply related [flat|nested] 10+ messages in thread
* [Qemu-devel] [PATCH 3/8] Documentation: Use UTF-8 encoding and fix one wrong encoding 2010-02-05 22:51 ` [Qemu-devel] [PATCH 2/8] Documentation: Add direntry for info format Stefan Weil @ 2010-02-05 22:52 ` Stefan Weil 2010-02-05 22:52 ` [Qemu-devel] [PATCH 4/8] Documentation: Add some basic documentation on make targets Stefan Weil 2010-02-10 19:30 ` [Qemu-devel] [PATCH 2/8] Documentation: Add direntry for info format Anthony Liguori 1 sibling, 1 reply; 10+ messages in thread From: Stefan Weil @ 2010-02-05 22:52 UTC (permalink / raw) To: QEMU Developers [-- Warning: decoded text below may be mangled, UTF-8 assumed --] [-- Attachment #1: Type: text/plain, Size: 1730 bytes --] At least for Linux distributions UTF-8 is now standard, so the QEMU documentation should use this encoding, too. Even if there was currently only a single special character using ISO-8859-1, this might change in the future. So the texinfo keywords @documentlanguage and @documentencoding now document the language and the encoding. The special character was changed to UTF-8 (it could also have been changed to an x, but the original cross looks really nice if it is displayed correctly). These changes fix the html presentation at http://www.qemu.org/qemu-doc.html#SEC65 (ARM System emulator). Signed-off-by: Stefan Weil <weil@mail.berlios.de> --- qemu-doc.texi | 6 +++++- qemu-tech.texi | 4 ++++ 2 files changed, 9 insertions(+), 1 deletions(-) diff --git a/qemu-doc.texi b/qemu-doc.texi index eba6437..84de318 100644 --- a/qemu-doc.texi +++ b/qemu-doc.texi @@ -1,6 +1,10 @@ \input texinfo @c -*- texinfo -*- @c %**start of header @setfilename qemu-doc.info + +@documentlanguage en +@documentencoding UTF-8 + @settitle QEMU Emulator User Documentation @exampleindent 0 @paragraphindent 0 @@ -1831,7 +1835,7 @@ MV88W8xx8 Ethernet controller @item MV88W8618 audio controller, WM8750 CODEC and mixer @item -128×64 display with brightness control +128×64 display with brightness control @item 2 buttons, 2 navigation wheels with button function @end itemize diff --git a/qemu-tech.texi b/qemu-tech.texi index 52560dc..2e2a081 100644 --- a/qemu-tech.texi +++ b/qemu-tech.texi @@ -1,6 +1,10 @@ \input texinfo @c -*- texinfo -*- @c %**start of header @setfilename qemu-tech.info + +@documentlanguage en +@documentencoding UTF-8 + @settitle QEMU Internals @exampleindent 0 @paragraphindent 0 -- 1.6.5 ^ permalink raw reply related [flat|nested] 10+ messages in thread
* [Qemu-devel] [PATCH 4/8] Documentation: Add some basic documentation on make targets 2010-02-05 22:52 ` [Qemu-devel] [PATCH 3/8] Documentation: Use UTF-8 encoding and fix one wrong encoding Stefan Weil @ 2010-02-05 22:52 ` Stefan Weil 2010-02-05 22:52 ` [Qemu-devel] [PATCH 5/8] Documentation: Fix item list Stefan Weil 0 siblings, 1 reply; 10+ messages in thread From: Stefan Weil @ 2010-02-05 22:52 UTC (permalink / raw) To: QEMU Developers This should help new users to get started. Signed-off-by: Stefan Weil <weil@mail.berlios.de> --- qemu-doc.texi | 41 +++++++++++++++++++++++++++++++++++++++++ 1 files changed, 41 insertions(+), 0 deletions(-) diff --git a/qemu-doc.texi b/qemu-doc.texi index 84de318..8ecd175 100644 --- a/qemu-doc.texi +++ b/qemu-doc.texi @@ -2286,6 +2286,7 @@ Run the emulation in single step mode. * Windows:: * Cross compilation for Windows with Linux:: * Mac OS X:: +* Make targets:: @end menu @node Linux/Unix @@ -2381,6 +2382,46 @@ The Mac OS X patches are not fully merged in QEMU, so you should look at the QEMU mailing list archive to have all the necessary information. +@node Make targets +@section Make targets + +@table @code + +@item make +@item make all +Make everything which is typically needed. + +@item install +TODO + +@item install-doc +TODO + +@item make clean +Remove most files which were built during make. + +@item make distclean +Remove everything which was built during make. + +@item make dvi +@item make html +@item make info +@item make pdf +Create documentation in dvi, html, info or pdf format. + +@item make cscope +TODO + +@item make defconfig +(Re-)create some build configuration files. +User made changes will be overwritten. + +@item tar +@item tarbin +TODO + +@end table + @node Index @chapter Index @printindex cp -- 1.6.5 ^ permalink raw reply related [flat|nested] 10+ messages in thread
* [Qemu-devel] [PATCH 5/8] Documentation: Fix item list 2010-02-05 22:52 ` [Qemu-devel] [PATCH 4/8] Documentation: Add some basic documentation on make targets Stefan Weil @ 2010-02-05 22:52 ` Stefan Weil 2010-02-05 22:52 ` [Qemu-devel] [PATCH 6/8] Documentation: Enhance documentation (index, keywords) Stefan Weil 0 siblings, 1 reply; 10+ messages in thread From: Stefan Weil @ 2010-02-05 22:52 UTC (permalink / raw) To: QEMU Developers @itemize @minus does not work as expected (the items start with "* -"). A simple @itemize gives a better result. Signed-off-by: Stefan Weil <weil@mail.berlios.de> --- qemu-doc.texi | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/qemu-doc.texi b/qemu-doc.texi index 8ecd175..4ac3183 100644 --- a/qemu-doc.texi +++ b/qemu-doc.texi @@ -58,7 +58,7 @@ achieve good emulation speed. QEMU has two operating modes: -@itemize @minus +@itemize @item Full system emulation. In this mode, QEMU emulates a full system (for -- 1.6.5 ^ permalink raw reply related [flat|nested] 10+ messages in thread
* [Qemu-devel] [PATCH 6/8] Documentation: Enhance documentation (index, keywords) 2010-02-05 22:52 ` [Qemu-devel] [PATCH 5/8] Documentation: Fix item list Stefan Weil @ 2010-02-05 22:52 ` Stefan Weil 2010-02-05 22:52 ` [Qemu-devel] [PATCH 7/8] Documentation: Add monitor commands to function index Stefan Weil 0 siblings, 1 reply; 10+ messages in thread From: Stefan Weil @ 2010-02-05 22:52 UTC (permalink / raw) To: QEMU Developers * Add some keywords for the concept index. * Add some keywords for the keystroke index. * Mark invalid or unclear documentation with TODO. Is there a better proposal how to do this? * Fix copy+paste error in ColdFire section (options were copied from ARM). * Fix documentation for Wine. * Add placeholders for missing system emulations. * Add placeholders for missing user emulation commands. * Add an appendix with license (to be discussed). * Add an appendix for every type of index which is supported by texinfo. Currently, not all are used, but this might change in the future. Signed-off-by: Stefan Weil <weil@mail.berlios.de> --- qemu-doc.texi | 165 +++++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 files changed, 156 insertions(+), 9 deletions(-) diff --git a/qemu-doc.texi b/qemu-doc.texi index 4ac3183..3d723f6 100644 --- a/qemu-doc.texi +++ b/qemu-doc.texi @@ -37,6 +37,7 @@ * QEMU System emulator for non PC targets:: * QEMU User space emulator:: * compilation:: Compilation from the sources +* License:: * Index:: @end menu @end ifnottex @@ -59,14 +60,17 @@ achieve good emulation speed. QEMU has two operating modes: @itemize +@cindex operating modes @item +@cindex system emulation Full system emulation. In this mode, QEMU emulates a full system (for example a PC), including one or several processors and various peripherals. It can be used to launch different Operating Systems without rebooting the PC or to debug system code. @item +@cindex user mode emulation User mode emulation. In this mode, QEMU can launch processes compiled for one CPU on another CPU. It can be used to launch the Wine Windows API emulator (@url{http://www.winehq.org}) or @@ -79,6 +83,8 @@ performance. For system emulation, the following hardware targets are supported: @itemize +@cindex emulated target systems +@cindex supported target systems @item PC (x86 or x86_64 processor) @item ISA PC (old style PC without PCI bus) @item PREP (PowerPC processor) @@ -106,7 +112,10 @@ For system emulation, the following hardware targets are supported: @item Petalogix Spartan 3aDSP1800 MMU ref design (MicroBlaze). @end itemize -For user emulation, x86, PowerPC, ARM, 32-bit MIPS, Sparc32/64, ColdFire(m68k), CRISv32 and MicroBlaze CPUs are supported. +@cindex supported user mode targets +For user emulation, x86 (32 and 64 bit), PowerPC (32 and 64 bit), +ARM, MIPS (32 bit only), Sparc (32 and 64 bit), +Alpha, ColdFire(m68k), CRISv32 and MicroBlaze CPUs are supported. @node Installation @chapter Installation @@ -121,24 +130,29 @@ If you want to compile QEMU yourself, see @ref{compilation}. @node install_linux @section Linux +@cindex installation (Linux) If a precompiled package is available for your distribution - you just have to install it. Otherwise, see @ref{compilation}. @node install_windows @section Windows +@cindex installation (Windows) Download the experimental binary installer at @url{http://www.free.oszoo.org/@/download.html}. +TODO (no longer available) @node install_mac @section Mac OS X Download the experimental binary installer at @url{http://www.free.oszoo.org/@/download.html}. +TODO (no longer available) @node QEMU PC System emulator @chapter QEMU PC System emulator +@cindex system emulation (PC) @menu * pcsys_introduction:: Introduction @@ -229,6 +243,7 @@ CS4231A is the chip used in Windows Sound System and GUSMAX products @node pcsys_quickstart @section Quick Start +@cindex quick start Download and uncompress the linux image (@file{linux.img}) and type: @@ -263,12 +278,15 @@ targets do not need a disk image. During the graphical emulation, you can use the following keys: @table @key @item Ctrl-Alt-f +@kindex Ctrl-Alt-f Toggle full screen @item Ctrl-Alt-u +@kindex Ctrl-Alt-u Restore the screen's un-scaled dimensions @item Ctrl-Alt-n +@kindex Ctrl-Alt-n Switch to virtual console 'n'. Standard console mappings are: @table @emph @item 1 @@ -280,30 +298,44 @@ Serial port @end table @item Ctrl-Alt +@kindex Ctrl-Alt Toggle mouse and keyboard grab. @end table +@kindex Ctrl-Up +@kindex Ctrl-Down +@kindex Ctrl-PageUp +@kindex Ctrl-PageDown In the virtual consoles, you can use @key{Ctrl-Up}, @key{Ctrl-Down}, @key{Ctrl-PageUp} and @key{Ctrl-PageDown} to move in the back log. +@kindex Ctrl-a h During emulation, if you are using the @option{-nographic} option, use @key{Ctrl-a h} to get terminal commands: @table @key @item Ctrl-a h +@kindex Ctrl-a h @item Ctrl-a ? +@kindex Ctrl-a ? Print this help @item Ctrl-a x +@kindex Ctrl-a x Exit emulator @item Ctrl-a s +@kindex Ctrl-a s Save disk data back to file (if -snapshot) @item Ctrl-a t +@kindex Ctrl-a t Toggle console timestamps @item Ctrl-a b +@kindex Ctrl-a b Send break (magic sysrq in Linux) @item Ctrl-a c +@kindex Ctrl-a c Switch between console and monitor @item Ctrl-a Ctrl-a +@kindex Ctrl-a a Send Ctrl-a @end table @c man end @@ -323,6 +355,7 @@ Fabrice Bellard @node pcsys_monitor @section QEMU Monitor +@cindex QEMU monitor The QEMU monitor is used to give complex commands to the QEMU emulator. You can use it to: @@ -1286,16 +1319,20 @@ machines. Most of the options are similar to the PC emulator. The differences are mentioned in the following sections. @menu -* QEMU PowerPC System emulator:: +* PowerPC System emulator:: * Sparc32 System emulator:: * Sparc64 System emulator:: * MIPS System emulator:: * ARM System emulator:: * ColdFire System emulator:: +* Cris System emulator:: +* Microblaze System emulator:: +* SH4 System emulator:: @end menu -@node QEMU PowerPC System emulator -@section QEMU PowerPC System emulator +@node PowerPC System emulator +@section PowerPC System emulator +@cindex system emulation (PowerPC) Use the executable @file{qemu-system-ppc} to simulate a complete PREP or PowerMac PowerPC system. @@ -1378,6 +1415,7 @@ More information is available at @node Sparc32 System emulator @section Sparc32 System emulator +@cindex system emulation (Sparc32) Use the executable @file{qemu-system-sparc} to simulate the following Sun4m architecture machines: @@ -1476,6 +1514,7 @@ Set the emulated machine type. Default is SS-5. @node Sparc64 System emulator @section Sparc64 System emulator +@cindex system emulation (Sparc64) Use the executable @file{qemu-system-sparc64} to simulate a Sun4u (UltraSPARC PC-like machine), Sun4v (T1 PC-like machine), or generic @@ -1525,6 +1564,7 @@ Set the emulated machine type. The default is sun4u. @node MIPS System emulator @section MIPS System emulator +@cindex system emulation (MIPS) Four executables cover simulation of 32 and 64-bit MIPS systems in both endian options, @file{qemu-system-mips}, @file{qemu-system-mipsel} @@ -1620,6 +1660,7 @@ G364 framebuffer @node ARM System emulator @section ARM System emulator +@cindex system emulation (ARM) Use the executable @file{qemu-system-arm} to simulate a ARM machine. The ARM Integrator/CP board is emulated with the following @@ -1905,6 +1946,8 @@ so should only be used with trusted guest OS. @node ColdFire System emulator @section ColdFire System emulator +@cindex system emulation (ColdFire) +@cindex system emulation (M68K) Use the executable @file{qemu-system-m68k} to simulate a ColdFire machine. The emulator is able to boot a uClinux kernel. @@ -1931,7 +1974,7 @@ Two on-chip UARTs. @c man begin OPTIONS -The following options are specific to the ARM emulation: +The following options are specific to the ColdFire emulation: @table @option @@ -1945,6 +1988,24 @@ so should only be used with trusted guest OS. @end table +@node Cris System emulator +@section Cris System emulator +@cindex system emulation (Cris) + +TODO + +@node Microblaze System emulator +@section Microblaze System emulator +@cindex system emulation (Microblaze) + +TODO + +@node SH4 System emulator +@section SH4 System emulator +@cindex system emulation (SH4) + +TODO + @node QEMU User space emulator @chapter QEMU User space emulator @@ -2109,16 +2170,49 @@ flag-style arguments don't have decoders and will show up as numbers. @node Other binaries @subsection Other binaries +@cindex user mode (Alpha) +@command{qemu-alpha} TODO. + +@cindex user mode (ARM) +@command{qemu-armeb} TODO. + +@cindex user mode (ARM) @command{qemu-arm} is also capable of running ARM "Angel" semihosted ELF binaries (as implemented by the arm-elf and arm-eabi Newlib/GDB configurations), and arm-uclinux bFLT format binaries. +@cindex user mode (ColdFire) +@cindex user mode (M68K) @command{qemu-m68k} is capable of running semihosted binaries using the BDM (m5xxx-ram-hosted.ld) or m68k-sim (sim.ld) syscall interfaces, and coldfire uClinux bFLT format binaries. The binary format is detected automatically. +@cindex user mode (Cris) +@command{qemu-cris} TODO. + +@cindex user mode (i386) +@command{qemu-i386} TODO. +@command{qemu-x86_64} TODO. + +@cindex user mode (Microblaze) +@command{qemu-microblaze} TODO. + +@cindex user mode (MIPS) +@command{qemu-mips} TODO. +@command{qemu-mipsel} TODO. + +@cindex user mode (PowerPC) +@command{qemu-ppc64abi32} TODO. +@command{qemu-ppc64} TODO. +@command{qemu-ppc} TODO. + +@cindex user mode (SH4) +@command{qemu-sh4eb} TODO. +@command{qemu-sh4} TODO. + +@cindex user mode (SPARC) @command{qemu-sparc} can execute Sparc32 binaries (Sparc32 CPU, 32 bit ABI). @command{qemu-sparc32plus} can execute Sparc32 and SPARC32PLUS binaries @@ -2372,15 +2466,18 @@ installation directory. @end itemize -Note: Currently, Wine does not seem able to launch -QEMU for Win32. +@cindex wine, starting system emulation +Wine can launch QEMU for Win32: +@example +wine qemu.exe +@end example @node Mac OS X @section Mac OS X The Mac OS X patches are not fully merged in QEMU, so you should look at the QEMU mailing list archive to have all the necessary -information. +information. (TODO: is this still true?) @node Make targets @section Make targets @@ -2422,8 +2519,58 @@ TODO @end table +@node License +@appendix License + +QEMU is a trademark of Fabrice Bellard. + +QEMU is released under the GNU General Public License (TODO: add link). +Parts of QEMU have specific licenses, see file LICENSE. + +TODO (refer to file LICENSE, include it, include the GPL?) + @node Index -@chapter Index +@appendix Index +@menu +* Concept Index:: +* Function Index:: +* Keystroke Index:: +* Program Index:: +* Data Type Index:: +* Variable Index:: +@end menu + +@node Concept Index +@section Concept Index +This is the main index. Should we combine all keywords in one index? TODO @printindex cp +@node Function Index +@section Function Index +This index could be used for command line options and monitor functions. +@printindex fn + +@node Keystroke Index +@section Keystroke Index + +This is a list of all keystrokes which have a special function +in system emulation. + +@printindex ky + +@node Program Index +@section Program Index +@printindex pg + +@node Data Type Index +@section Data Type Index + +This index could be used for qdev device names and options. + +@printindex tp + +@node Variable Index +@section Variable Index +@printindex vr + @bye -- 1.6.5 ^ permalink raw reply related [flat|nested] 10+ messages in thread
* [Qemu-devel] [PATCH 7/8] Documentation: Add monitor commands to function index 2010-02-05 22:52 ` [Qemu-devel] [PATCH 6/8] Documentation: Enhance documentation (index, keywords) Stefan Weil @ 2010-02-05 22:52 ` Stefan Weil 2010-02-05 22:52 ` [Qemu-devel] [PATCH 8/8] Documentation: Add command line options " Stefan Weil 0 siblings, 1 reply; 10+ messages in thread From: Stefan Weil @ 2010-02-05 22:52 UTC (permalink / raw) To: QEMU Developers * Add monitor commands to function index. * Fix description for acl_remove. Signed-off-by: Stefan Weil <weil@mail.berlios.de> --- qemu-monitor.hx | 62 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 files changed, 61 insertions(+), 1 deletions(-) diff --git a/qemu-monitor.hx b/qemu-monitor.hx index e5bff8e..cf9e430 100644 --- a/qemu-monitor.hx +++ b/qemu-monitor.hx @@ -19,6 +19,7 @@ ETEXI STEXI @item help or ? [@var{cmd}] +@findex help Show the help for all commands or just for command @var{cmd}. ETEXI @@ -32,6 +33,7 @@ ETEXI STEXI @item commit +@findex commit Commit changes to the disk images (if -snapshot is used) or backing files. ETEXI @@ -46,6 +48,7 @@ ETEXI STEXI @item info @var{subcommand} +@findex info Show various information about the system state. @table @option @@ -125,6 +128,7 @@ ETEXI STEXI @item q or quit +@findex quit Quit the emulator. ETEXI @@ -139,6 +143,7 @@ ETEXI STEXI @item eject [-f] @var{device} +@findex eject Eject a removable medium (use -f to force it). ETEXI @@ -153,6 +158,7 @@ ETEXI STEXI @item change @var{device} @var{setting} +@findex change Change the configuration of a device. @@ -198,6 +204,7 @@ ETEXI STEXI @item screendump @var{filename} +@findex screendump Save screen into PPM image @var{filename}. ETEXI @@ -211,6 +218,7 @@ ETEXI STEXI @item logfile @var{filename} +@findex logfile Output logs to @var{filename}. ETEXI @@ -224,6 +232,7 @@ ETEXI STEXI @item log @var{item1}[,...] +@findex log Activate logging of the specified items to @file{/tmp/qemu.log}. ETEXI @@ -237,6 +246,7 @@ ETEXI STEXI @item savevm [@var{tag}|@var{id}] +@findex savevm Create a snapshot of the whole virtual machine. If @var{tag} is provided, it is used as human readable identifier. If there is already a snapshot with the same tag or ID, it is replaced. More info at @@ -253,6 +263,7 @@ ETEXI STEXI @item loadvm @var{tag}|@var{id} +@findex loadvm Set the whole virtual machine to the snapshot identified by the tag @var{tag} or the unique snapshot ID @var{id}. ETEXI @@ -267,6 +278,7 @@ ETEXI STEXI @item delvm @var{tag}|@var{id} +@findex delvm Delete the snapshot identified by @var{tag} or @var{id}. ETEXI @@ -280,6 +292,7 @@ ETEXI STEXI @item singlestep [off] +@findex singlestep Run the emulation in single step mode. If called with option off, the emulation returns to normal mode. ETEXI @@ -295,6 +308,7 @@ ETEXI STEXI @item stop +@findex stop Stop emulation. ETEXI @@ -309,6 +323,7 @@ ETEXI STEXI @item c or cont +@findex cont Resume emulation. ETEXI @@ -322,6 +337,7 @@ ETEXI STEXI @item gdbserver [@var{port}] +@findex gdbserver Start gdbserver session (default @var{port}=1234) ETEXI @@ -335,6 +351,7 @@ ETEXI STEXI @item x/fmt @var{addr} +@findex x Virtual memory dump starting at @var{addr}. ETEXI @@ -348,6 +365,7 @@ ETEXI STEXI @item xp /@var{fmt} @var{addr} +@findex xp Physical memory dump starting at @var{addr}. @var{fmt} is a format which tells the command how to format the @@ -355,13 +373,16 @@ data. Its syntax is: @option{/@{count@}@{format@}@{size@}} @table @var @item count +@findex count is the number of items to be dumped. @item format +@findex format can be x (hex), d (signed decimal), u (unsigned decimal), o (octal), c (char) or i (asm instruction). @item size +@findex size can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86, @code{h} or @code{w} can be specified with the @code{i} format to respectively select 16 or 32 bit code instruction size. @@ -414,6 +435,7 @@ ETEXI STEXI @item p or print/@var{fmt} @var{expr} +@findex print Print expression value. Only the @var{format} part of @var{fmt} is used. @@ -453,6 +475,7 @@ ETEXI STEXI @item sendkey @var{keys} +@findex sendkey Send @var{keys} to the emulator. @var{keys} could be the name of the key or @code{#} followed by the raw value in either decimal or hexadecimal @@ -476,6 +499,7 @@ ETEXI STEXI @item system_reset +@findex system_reset Reset the system. ETEXI @@ -491,6 +515,7 @@ ETEXI STEXI @item system_powerdown +@findex system_powerdown Power down the system (if supported). ETEXI @@ -505,6 +530,7 @@ ETEXI STEXI @item sum @var{addr} @var{size} +@findex sum Compute the checksum of a memory region. ETEXI @@ -519,6 +545,7 @@ ETEXI STEXI @item usb_add @var{devname} +@findex usb_add Add the USB device @var{devname}. For details of available devices see @ref{usb_devices} @@ -534,6 +561,7 @@ ETEXI STEXI @item usb_del @var{devname} +@findex usb_del Remove the USB device @var{devname} from the QEMU virtual USB hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor @@ -550,6 +578,7 @@ ETEXI STEXI @item device_add @var{config} +@findex device_add Add device. ETEXI @@ -564,6 +593,7 @@ ETEXI STEXI @item device_del @var{id} +@findex device_del Remove device @var{id}. ETEXI @@ -591,6 +621,7 @@ ETEXI STEXI @item mouse_move @var{dx} @var{dy} [@var{dz}] +@findex mouse_move Move the active mouse to the specified coordinates @var{dx} @var{dy} with optional scroll axis @var{dz}. ETEXI @@ -605,6 +636,7 @@ ETEXI STEXI @item mouse_button @var{val} +@findex mouse_button Change the active mouse button state @var{val} (1=L, 2=M, 4=R). ETEXI @@ -618,6 +650,7 @@ ETEXI STEXI @item mouse_set @var{index} +@findex mouse_set Set which mouse device receives events at given @var{index}, index can be obtained with @example @@ -636,6 +669,7 @@ ETEXI #endif STEXI @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]] +@findex wavcapture Capture audio into @var{filename}. Using sample rate @var{frequency} bits per sample @var{bits} and number of channels @var{channels}. @@ -658,6 +692,7 @@ ETEXI #endif STEXI @item stopcapture @var{index} +@findex stopcapture Stop capture with a given @var{index}, index can be obtained with @example info capture @@ -675,6 +710,7 @@ ETEXI STEXI @item memsave @var{addr} @var{size} @var{file} +@findex memsave save to disk virtual memory dump starting at @var{addr} of size @var{size}. ETEXI @@ -689,6 +725,7 @@ ETEXI STEXI @item pmemsave @var{addr} @var{size} @var{file} +@findex pmemsave save to disk physical memory dump starting at @var{addr} of size @var{size}. ETEXI @@ -702,6 +739,7 @@ ETEXI STEXI @item boot_set @var{bootdevicelist} +@findex boot_set Define new values for the boot device list. Those values will override the values specified on the command line through the @code{-boot} option. @@ -721,6 +759,7 @@ ETEXI #endif STEXI @item nmi @var{cpu} +@findex nmi Inject an NMI on the given CPU (x86 only). ETEXI @@ -740,6 +779,7 @@ ETEXI STEXI @item migrate [-d] [-b] [-i] @var{uri} +@findex migrate Migrate to @var{uri} (using -d to not wait for completion). -b for migration with full copy of disk -i for migration with incremental copy of disk (base image is shared) @@ -756,6 +796,7 @@ ETEXI STEXI @item migrate_cancel +@findex migrate_cancel Cancel the current VM migration. ETEXI @@ -770,6 +811,7 @@ ETEXI STEXI @item migrate_set_speed @var{value} +@findex migrate_set_speed Set maximum speed to @var{value} (in bytes) for migrations. ETEXI @@ -784,6 +826,7 @@ ETEXI STEXI @item migrate_set_downtime @var{second} +@findex migrate_set_downtime Set maximum tolerated downtime (in seconds) for migration. ETEXI @@ -803,6 +846,7 @@ ETEXI STEXI @item drive_add +@findex drive_add Add drive to PCI storage controller. ETEXI @@ -819,6 +863,7 @@ ETEXI STEXI @item pci_add +@findex pci_add Hot-add PCI device. ETEXI @@ -835,6 +880,7 @@ ETEXI STEXI @item pci_del +@findex pci_del Hot remove PCI device. ETEXI @@ -848,6 +894,7 @@ ETEXI STEXI @item host_net_add +@findex host_net_add Add host VLAN client. ETEXI @@ -861,6 +908,7 @@ ETEXI STEXI @item host_net_remove +@findex host_net_remove Remove host VLAN client. ETEXI @@ -884,6 +932,7 @@ ETEXI #endif STEXI @item host_net_redir +@findex host_net_redir Redirect TCP or UDP connections from host to guest (requires -net user). ETEXI @@ -899,6 +948,7 @@ ETEXI STEXI @item balloon @var{value} +@findex balloon Request VM to change its memory allocation to @var{value} (in MB). ETEXI @@ -912,6 +962,7 @@ ETEXI STEXI @item set_link @var{name} [up|down] +@findex set_link Set link @var{name} up or down. ETEXI @@ -925,6 +976,7 @@ ETEXI STEXI @item watchdog_action +@findex watchdog_action Change watchdog action. ETEXI @@ -938,6 +990,7 @@ ETEXI STEXI @item acl_show @var{aclname} +@findex acl_show List all the matching rules in the access control list, and the default policy. There are currently two named access control lists, @var{vnc.x509dname} and @var{vnc.username} matching on the x509 client @@ -954,6 +1007,7 @@ ETEXI STEXI @item acl_policy @var{aclname} @code{allow|deny} +@findex acl_policy Set the default access control list policy, used in the event that none of the explicit rules match. The default policy at startup is always @code{deny}. @@ -969,6 +1023,7 @@ ETEXI STEXI @item acl_allow @var{aclname} @var{match} @code{allow|deny} [@var{index}] +@findex acl_allow Add a match rule to the access control list, allowing or denying access. The match will normally be an exact username or x509 distinguished name, but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to @@ -987,6 +1042,7 @@ ETEXI STEXI @item acl_remove @var{aclname} @var{match} +@findex acl_remove Remove the specified match rule from the access control list. ETEXI @@ -999,7 +1055,7 @@ ETEXI }, STEXI -@item acl_remove @var{aclname} @var{match} +@item acl_remove @var{aclname} Remove all matches from the access control list, and set the default policy back to @code{deny}. ETEXI @@ -1017,6 +1073,7 @@ ETEXI #endif STEXI @item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc} +@findex mce (x86) Inject an MCE on the given CPU (x86 only). ETEXI @@ -1031,6 +1088,7 @@ ETEXI STEXI @item getfd @var{fdname} +@findex getfd If a file descriptor is passed alongside this command using the SCM_RIGHTS mechanism on unix sockets, it is stored using the name @var{fdname} for later use by other monitor commands. @@ -1047,6 +1105,7 @@ ETEXI STEXI @item closefd @var{fdname} +@findex closefd Close the file descriptor previously assigned to @var{fdname} using the @code{getfd} command. This is only needed if the file descriptor was never used by another monitor command. @@ -1063,6 +1122,7 @@ ETEXI STEXI @item block_passwd @var{device} @var{password} +@findex block_passwd Set the encrypted device @var{device} password to @var{password} ETEXI -- 1.6.5 ^ permalink raw reply related [flat|nested] 10+ messages in thread
* [Qemu-devel] [PATCH 8/8] Documentation: Add command line options to function index 2010-02-05 22:52 ` [Qemu-devel] [PATCH 7/8] Documentation: Add monitor commands to function index Stefan Weil @ 2010-02-05 22:52 ` Stefan Weil 0 siblings, 0 replies; 10+ messages in thread From: Stefan Weil @ 2010-02-05 22:52 UTC (permalink / raw) To: QEMU Developers * Add line options to function index. * Add description for -set (TODO). * Add description for -global (TODO). Signed-off-by: Stefan Weil <weil@mail.berlios.de> --- qemu-options.hx | 153 +++++++++++++++++++++++++++++++++++++++++++++---------- 1 files changed, 125 insertions(+), 28 deletions(-) diff --git a/qemu-options.hx b/qemu-options.hx index 4c1bcfb..0105da7 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -14,6 +14,7 @@ DEF("help", 0, QEMU_OPTION_h, "-h or -help display this help and exit\n") STEXI @item -h +@findex -h Display help and exit ETEXI @@ -21,6 +22,7 @@ DEF("version", 0, QEMU_OPTION_version, "-version display version information and exit\n") STEXI @item -version +@findex -version Display version information and exit ETEXI @@ -28,6 +30,7 @@ DEF("M", HAS_ARG, QEMU_OPTION_M, "-M machine select emulated machine (-M ? for list)\n") STEXI @item -M @var{machine} +@findex -M Select the emulated @var{machine} (@code{-M ?} for list) ETEXI @@ -35,6 +38,7 @@ DEF("cpu", HAS_ARG, QEMU_OPTION_cpu, "-cpu cpu select CPU (-cpu ? for list)\n") STEXI @item -cpu @var{model} +@findex -cpu Select CPU model (-cpu ? for list and additional feature selection) ETEXI @@ -48,6 +52,7 @@ DEF("smp", HAS_ARG, QEMU_OPTION_smp, " sockets= number of discrete sockets in the system\n") STEXI @item -smp @var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}] +@findex -smp Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255 CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs to 4. @@ -62,6 +67,7 @@ DEF("numa", HAS_ARG, QEMU_OPTION_numa, "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n") STEXI @item -numa @var{opts} +@findex -numa Simulate a multi node NUMA system. If mem and cpus are omitted, resources are split equally. ETEXI @@ -72,6 +78,8 @@ DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "") STEXI @item -fda @var{file} @item -fdb @var{file} +@findex -fda +@findex -fdb Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}). ETEXI @@ -87,6 +95,10 @@ STEXI @item -hdb @var{file} @item -hdc @var{file} @item -hdd @var{file} +@findex -hda +@findex -hdb +@findex -hdc +@findex -hdd Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}). ETEXI @@ -94,6 +106,7 @@ DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom, "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n") STEXI @item -cdrom @var{file} +@findex -cdrom Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and @option{-cdrom} at the same time). You can use the host CD-ROM by using @file{/dev/cdrom} as filename (@pxref{host_drives}). @@ -105,15 +118,9 @@ DEF("drive", HAS_ARG, QEMU_OPTION_drive, " [,cache=writethrough|writeback|none][,format=f][,serial=s]\n" " [,addr=A][,id=name][,aio=threads|native][,readonly=on|off]\n" " use 'file' as a drive image\n") -DEF("set", HAS_ARG, QEMU_OPTION_set, - "-set group.id.arg=value\n" - " set <arg> parameter for item <id> of type <group>\n" - " i.e. -set drive.$id.file=/path/to/image\n") -DEF("global", HAS_ARG, QEMU_OPTION_global, - "-global driver.property=value\n" - " set a global default for a driver property\n") STEXI @item -drive @var{option}[,@var{option}[,@var{option}[,...]]] +@findex -drive Define a new drive. Valid options are: @@ -216,11 +223,30 @@ qemu -hda a -hdb b @end example ETEXI +DEF("set", HAS_ARG, QEMU_OPTION_set, + "-set group.id.arg=value\n" + " set <arg> parameter for item <id> of type <group>\n" + " i.e. -set drive.$id.file=/path/to/image\n") +STEXI +@item -set +@findex -set +TODO +ETEXI + +DEF("global", HAS_ARG, QEMU_OPTION_global, + "-global driver.property=value\n" + " set a global default for a driver property\n") +STEXI +@item -global +@findex -global +TODO +ETEXI + DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock, "-mtdblock file use 'file' as on-board Flash memory image\n") STEXI - @item -mtdblock @var{file} +@findex -mtdblock Use @var{file} as on-board Flash memory image. ETEXI @@ -228,6 +254,7 @@ DEF("sd", HAS_ARG, QEMU_OPTION_sd, "-sd file use 'file' as SecureDigital card image\n") STEXI @item -sd @var{file} +@findex -sd Use @var{file} as SecureDigital card image. ETEXI @@ -235,6 +262,7 @@ DEF("pflash", HAS_ARG, QEMU_OPTION_pflash, "-pflash file use 'file' as a parallel flash image\n") STEXI @item -pflash @var{file} +@findex -pflash Use @var{file} as a parallel flash image. ETEXI @@ -243,7 +271,7 @@ DEF("boot", HAS_ARG, QEMU_OPTION_boot, " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n") STEXI @item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off] - +@findex -boot Specify boot order @var{drives} as a string of drive letters. Valid drive letters depend on the target achitecture. The x86 PC uses: a, b (floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot @@ -269,6 +297,7 @@ DEF("snapshot", 0, QEMU_OPTION_snapshot, "-snapshot write to temporary files instead of disk image files\n") STEXI @item -snapshot +@findex -snapshot Write to temporary files instead of disk image files. In this case, the raw disk image you use is not written back. You can however force the write back by pressing @key{C-a s} (@pxref{disk_images}). @@ -278,6 +307,7 @@ DEF("m", HAS_ARG, QEMU_OPTION_m, "-m megs set virtual RAM size to megs MB [default=%d]\n") STEXI @item -m @var{megs} +@findex -m Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally, a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or gigabytes respectively. @@ -287,7 +317,7 @@ DEF("k", HAS_ARG, QEMU_OPTION_k, "-k language use keyboard layout (for example 'fr' for French)\n") STEXI @item -k @var{language} - +@findex -k Use keyboard layout @var{language} (for example @code{fr} for French). This option is only needed where it is not easy to get raw PC keycodes (e.g. on Macs, with some X11 servers or with a VNC @@ -311,7 +341,7 @@ DEF("audio-help", 0, QEMU_OPTION_audio_help, #endif STEXI @item -audio-help - +@findex -audio-help Will show the audio subsystem help: list of drivers, tunable parameters. ETEXI @@ -325,7 +355,7 @@ DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw, #endif STEXI @item -soundhw @var{card1}[,@var{card2},...] or -soundhw all - +@findex -soundhw Enable audio and selected sound hardware. Use ? to print all available sound hardware. @@ -356,6 +386,7 @@ USB options: @table @option @item -usb +@findex -usb Enable the USB driver (will be the default soon) ETEXI @@ -364,6 +395,7 @@ DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice, STEXI @item -usbdevice @var{devname} +@findex -usbdevice Add the USB device @var{devname}. @xref{usb_devices}. @table @option @@ -407,13 +439,17 @@ DEF("device", HAS_ARG, QEMU_OPTION_device, " add device (based on driver)\n" " prop=value,... sets driver properties\n" " use -device ? to print all possible drivers\n" - " use -device driver,? to print all possible properties\n") + " use -device driver,? to print all possible options\n" + " use -device driver,option=? to print a help for value\n") STEXI -@item -device @var{driver}[,@var{prop}[=@var{value}][,...]] -Add device @var{driver}. @var{prop}=@var{value} sets driver -properties. Valid properties depend on the driver. To get help on -possible drivers and properties, use @code{-device ?} and -@code{-device @var{driver},?}. +@item -device @var{driver}[,@var{option}[=@var{value}][,...]] +@findex -device +Add device @var{driver}. Depending on the device type, +@var{option} (with default or given @var{value}) may be useful. +To get a help on possible @var{driver}s, @var{option}s or @var{value}s, use +@code{-device ?}, +@code{-device @var{driver},?} or +@code{-device @var{driver},@var{option}=?}. ETEXI DEF("name", HAS_ARG, QEMU_OPTION_name, @@ -422,6 +458,7 @@ DEF("name", HAS_ARG, QEMU_OPTION_name, " string1 sets the window title and string2 the process name (on Linux)\n") STEXI @item -name @var{name} +@findex -name Sets the @var{name} of the guest. This name will be displayed in the SDL window caption. The @var{name} will also be used for the VNC server. @@ -433,6 +470,7 @@ DEF("uuid", HAS_ARG, QEMU_OPTION_uuid, " specify machine UUID\n") STEXI @item -uuid @var{uuid} +@findex -uuid Set system UUID. ETEXI @@ -452,7 +490,7 @@ DEF("nographic", 0, QEMU_OPTION_nographic, "-nographic disable graphical output and redirect serial I/Os to console\n") STEXI @item -nographic - +@findex -nographic Normally, QEMU uses SDL to display the VGA output. With this option, you can totally disable graphical output so that QEMU is a simple command line application. The emulated serial port is redirected on @@ -466,7 +504,7 @@ DEF("curses", 0, QEMU_OPTION_curses, #endif STEXI @item -curses - +@findex curses Normally, QEMU uses SDL to display the VGA output. With this option, QEMU can display the VGA output when in text mode using a curses/ncurses interface. Nothing is displayed in graphical mode. @@ -478,7 +516,7 @@ DEF("no-frame", 0, QEMU_OPTION_no_frame, #endif STEXI @item -no-frame - +@findex -no-frame Do not use decorations for SDL windows and start them using the whole available screen space. This makes the using QEMU in a dedicated desktop workspace more convenient. @@ -490,7 +528,7 @@ DEF("alt-grab", 0, QEMU_OPTION_alt_grab, #endif STEXI @item -alt-grab - +@findex -alt-grab Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). ETEXI @@ -500,7 +538,7 @@ DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab, #endif STEXI @item -ctrl-grab - +@findex -ctrl-grab Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). ETEXI @@ -510,7 +548,7 @@ DEF("no-quit", 0, QEMU_OPTION_no_quit, #endif STEXI @item -no-quit - +@findex -no-quit Disable SDL window close capability. ETEXI @@ -520,7 +558,7 @@ DEF("sdl", 0, QEMU_OPTION_sdl, #endif STEXI @item -sdl - +@findex -sdl Enable SDL. ETEXI @@ -528,7 +566,7 @@ DEF("portrait", 0, QEMU_OPTION_portrait, "-portrait rotate graphical output 90 deg left (only PXA LCD)\n") STEXI @item -portrait - +@findex -portrait Rotate graphical output 90 deg left (only PXA LCD). ETEXI @@ -537,6 +575,7 @@ DEF("vga", HAS_ARG, QEMU_OPTION_vga, " select video card type\n") STEXI @item -vga @var{type} +@findex -vga Select type of VGA card to emulate. Valid values for @var{type} are @table @option @item cirrus @@ -562,6 +601,7 @@ DEF("full-screen", 0, QEMU_OPTION_full_screen, "-full-screen start in full screen\n") STEXI @item -full-screen +@findex -full-screen Start in full screen. ETEXI @@ -571,6 +611,7 @@ DEF("g", 1, QEMU_OPTION_g , #endif STEXI @item -g @var{width}x@var{height}[x@var{depth}] +@findex -g Set the initial graphical resolution and depth (PPC, SPARC only). ETEXI @@ -578,7 +619,7 @@ DEF("vnc", HAS_ARG, QEMU_OPTION_vnc , "-vnc display start a VNC server on display\n") STEXI @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]] - +@findex -vnc Normally, QEMU uses SDL to display the VGA output. With this option, you can have QEMU listen on VNC display @var{display} and redirect the VGA display over the VNC session. It is very useful to enable the usb @@ -704,6 +745,7 @@ DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack, #endif STEXI @item -win2k-hack +@findex -win2k-hack Use it when installing Windows 2000 to avoid a disk full bug. After Windows 2000 is installed, you no longer need this option (this option slows down the IDE transfers). @@ -720,8 +762,10 @@ DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk, #endif STEXI @item -no-fd-bootchk +@findex -no-fd-bootchk Disable boot signature checking for floppy disks in Bochs BIOS. It may be needed to boot from old floppy disks. +TODO: check reference to Bochs BIOS. ETEXI #ifdef TARGET_I386 @@ -730,6 +774,7 @@ DEF("no-acpi", 0, QEMU_OPTION_no_acpi, #endif STEXI @item -no-acpi +@findex -no-acpi Disable ACPI (Advanced Configuration and Power Interface) support. Use it if your guest OS complains about ACPI problems (PC target machine only). @@ -741,6 +786,7 @@ DEF("no-hpet", 0, QEMU_OPTION_no_hpet, #endif STEXI @item -no-hpet +@findex -no-hpet Disable HPET support. ETEXI @@ -752,6 +798,7 @@ DEF("balloon", HAS_ARG, QEMU_OPTION_balloon, #endif STEXI @item -balloon none +@findex -balloon Disable balloon device. @item -balloon virtio[,addr=@var{addr}] Enable virtio balloon device (default), optionally with PCI address @@ -765,6 +812,7 @@ DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable, #endif STEXI @item -acpitable [sig=@var{str}][,rev=@var{n}][,oem_id=@var{str}][,oem_table_id=@var{str}][,oem_rev=@var{n}] [,asl_compiler_id=@var{str}][,asl_compiler_rev=@var{n}][,data=@var{file1}[:@var{file2}]...] +@findex -acpitable Add ACPI table with specified header fields and context from specified files. ETEXI @@ -780,9 +828,11 @@ DEF("smbios", HAS_ARG, QEMU_OPTION_smbios, #endif STEXI @item -smbios file=@var{binary} +@findex -smbios Load SMBIOS entry from binary file. @item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}] +@findex -smbios Specify SMBIOS type 0 fields @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}] @@ -866,6 +916,7 @@ DEF("netdev", HAS_ARG, QEMU_OPTION_netdev, "socket],id=str[,option][,option][,...]\n") STEXI @item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}][,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}] +@findex -net Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n} = 0 is the default). The NIC is an e1000 by default on the PC target. Optionally, the MAC address can be changed to @var{mac}, the @@ -1143,7 +1194,7 @@ The general form of a character device option is: @table @option @item -chardev @var{backend} ,id=@var{id} [,@var{options}] - +@findex -chardev Backend is one of: @option{null}, @option{socket}, @@ -1347,6 +1398,7 @@ STEXI @table @option @item -bt hci[...] +@findex -bt Defines the function of the corresponding Bluetooth HCI. -bt options are matched with the HCIs present in the chosen machine type. For example when emulating a machine with only one HCI built into it, only @@ -1415,6 +1467,7 @@ DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \ "-kernel bzImage use 'bzImage' as kernel image\n") STEXI @item -kernel @var{bzImage} +@findex -kernel Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel or in multiboot format. ETEXI @@ -1423,6 +1476,7 @@ DEF("append", HAS_ARG, QEMU_OPTION_append, \ "-append cmdline use 'cmdline' as kernel command line\n") STEXI @item -append @var{cmdline} +@findex -append Use @var{cmdline} as kernel command line ETEXI @@ -1430,6 +1484,7 @@ DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \ "-initrd file use 'file' as initial ram disk\n") STEXI @item -initrd @var{file} +@findex -initrd Use @var{file} as initial ram disk. @item -initrd "@var{file1} arg=foo,@var{file2}" @@ -1456,6 +1511,7 @@ DEF("serial", HAS_ARG, QEMU_OPTION_serial, \ "-serial dev redirect the serial port to char device 'dev'\n") STEXI @item -serial @var{dev} +@findex -serial Redirect the virtual serial port to host character device @var{dev}. The default device is @code{vc} in graphical mode and @code{stdio} in non graphical mode. @@ -1583,6 +1639,7 @@ DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \ "-parallel dev redirect the parallel port to char device 'dev'\n") STEXI @item -parallel @var{dev} +@findex -parallel Redirect the virtual parallel port to host device @var{dev} (same devices as the serial port). On Linux hosts, @file{/dev/parportN} can be used to use hardware devices connected on the corresponding host @@ -1598,6 +1655,7 @@ DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \ "-monitor dev redirect the monitor to char device 'dev'\n") STEXI @item -monitor @var{dev} +@findex -monitor Redirect the monitor to host device @var{dev} (same devices as the serial port). The default device is @code{vc} in graphical mode and @code{stdio} in @@ -1607,6 +1665,7 @@ DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \ "-qmp dev like -monitor but opens in 'control' mode\n") STEXI @item -qmp @var{dev} +@findex -qmp Like -monitor but opens in 'control' mode. ETEXI @@ -1614,6 +1673,7 @@ DEF("mon", HAS_ARG, QEMU_OPTION_mon, \ "-mon chardev=[name][,mode=readline|control][,default]\n") STEXI @item -mon chardev=[name][,mode=readline|control][,default] +@findex -mon Setup monitor on chardev @var{name}. ETEXI @@ -1621,6 +1681,7 @@ DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \ "-debugcon dev redirect the debug console to char device 'dev'\n") STEXI @item -debugcon @var{dev} +@findex -debugcon Redirect the debug console to host device @var{dev} (same devices as the serial port). The debug console is an I/O port which is typically port 0xe9; writing to that I/O port sends output to this device. @@ -1632,6 +1693,7 @@ DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \ "-pidfile file write PID to 'file'\n") STEXI @item -pidfile @var{file} +@findex -pidfile Store the QEMU process PID in @var{file}. It is useful if you launch QEMU from a script. ETEXI @@ -1640,6 +1702,7 @@ DEF("singlestep", 0, QEMU_OPTION_singlestep, \ "-singlestep always run in singlestep mode\n") STEXI @item -singlestep +@findex -singlestep Run the emulation in single step mode. ETEXI @@ -1647,6 +1710,7 @@ DEF("S", 0, QEMU_OPTION_S, \ "-S freeze CPU at startup (use 'c' to start execution)\n") STEXI @item -S +@findex -S Do not start CPU at startup (you must type 'c' in the monitor). ETEXI @@ -1654,6 +1718,7 @@ DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \ "-gdb dev wait for gdb connection on 'dev'\n") STEXI @item -gdb @var{dev} +@findex -gdb Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical connections will likely be TCP-based, but also UDP, pseudo TTY, or even stdio are reasonable use case. The latter is allowing to start qemu from @@ -1667,6 +1732,7 @@ DEF("s", 0, QEMU_OPTION_s, \ "-s shorthand for -gdb tcp::%s\n") STEXI @item -s +@findex -s Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234 (@pxref{gdb_usage}). ETEXI @@ -1675,6 +1741,7 @@ DEF("d", HAS_ARG, QEMU_OPTION_d, \ "-d item1,... output log to %s (use -d ? for a list of log items)\n") STEXI @item -d +@findex -d Output log in /tmp/qemu.log ETEXI @@ -1684,6 +1751,7 @@ DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \ " translation (t=none or lba) (usually qemu can guess them)\n") STEXI @item -hdachs @var{c},@var{h},@var{s},[,@var{t}] +@findex -hdachs Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <= @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS translation mode (@var{t}=none, lba or auto). Usually QEMU can guess @@ -1695,6 +1763,7 @@ DEF("L", HAS_ARG, QEMU_OPTION_L, \ "-L path set the directory for the BIOS, VGA BIOS and keymaps\n") STEXI @item -L @var{path} +@findex -L Set the directory for the BIOS, VGA BIOS and keymaps. ETEXI @@ -1702,6 +1771,7 @@ DEF("bios", HAS_ARG, QEMU_OPTION_bios, \ "-bios file set the filename for the BIOS\n") STEXI @item -bios @var{file} +@findex -bios Set the filename for the BIOS. ETEXI @@ -1711,6 +1781,7 @@ DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \ #endif STEXI @item -enable-kvm +@findex -enable-kvm Enable KVM full virtualization support. This option is only available if KVM support is enabled when compiling. ETEXI @@ -1727,11 +1798,14 @@ DEF("xen-attach", 0, QEMU_OPTION_xen_attach, #endif STEXI @item -xen-domid @var{id} +@findex -xen-domid Specify xen guest domain @var{id} (XEN only). @item -xen-create +@findex -xen-create Create domain using xen hypercalls, bypassing xend. Warning: should not be used when xend is in use (XEN only). @item -xen-attach +@findex -xen-attach Attach to existing xen domain. xend will use this when starting qemu (XEN only). ETEXI @@ -1740,6 +1814,7 @@ DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \ "-no-reboot exit instead of rebooting\n") STEXI @item -no-reboot +@findex -no-reboot Exit instead of rebooting. ETEXI @@ -1747,6 +1822,7 @@ DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \ "-no-shutdown stop before shutdown\n") STEXI @item -no-shutdown +@findex -no-shutdown Don't exit QEMU on guest shutdown, but instead only stop the emulation. This allows for instance switching to monitor to commit changes to the disk image. @@ -1757,6 +1833,7 @@ DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \ " start right away with a saved state (loadvm in monitor)\n") STEXI @item -loadvm @var{file} +@findex -loadvm Start right away with a saved state (@code{loadvm} in monitor) ETEXI @@ -1766,6 +1843,7 @@ DEF("daemonize", 0, QEMU_OPTION_daemonize, \ #endif STEXI @item -daemonize +@findex -daemonize Daemonize the QEMU process after initialization. QEMU will not detach from standard IO until it is ready to receive connections on any of its devices. This option is a useful way for external programs to launch QEMU without having @@ -1776,6 +1854,7 @@ DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \ "-option-rom rom load a file, rom, into the option ROM space\n") STEXI @item -option-rom @var{file} +@findex -option-rom Load the contents of @var{file} as an option ROM. This option is useful to load things like EtherBoot. ETEXI @@ -1785,6 +1864,7 @@ DEF("clock", HAS_ARG, QEMU_OPTION_clock, \ " To see what timers are available use -clock ?\n") STEXI @item -clock @var{method} +@findex -clock Force the use of the given methods for timer alarm. To see what timers are available use -clock ?. ETEXI @@ -1806,6 +1886,7 @@ DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ STEXI @item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew] +@findex -rtc Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current UTC or local time, respectively. @code{localtime} is required for correct date in MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the @@ -1829,6 +1910,7 @@ DEF("icount", HAS_ARG, QEMU_OPTION_icount, \ " instruction\n") STEXI @item -icount [@var{N}|auto] +@findex -icount Enable virtual instruction counter. The virtual cpu will execute one instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified then the virtual cpu speed will be automatically adjusted to keep virtual @@ -1845,6 +1927,7 @@ DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \ " enable virtual hardware watchdog [default=none]\n") STEXI @item -watchdog @var{model} +@findex -watchdog Create a virtual hardware watchdog device. Once enabled (by a guest action), the watchdog must be periodically polled by an agent inside the guest or else the guest will be restarted. @@ -1894,6 +1977,7 @@ DEF("echr", HAS_ARG, QEMU_OPTION_echr, \ STEXI @item -echr @var{numeric_ascii_value} +@findex -echr Change the escape character used for switching to the monitor when using monitor and serial sharing. The default is @code{0x01} when using the @code{-nographic} option. @code{0x01} is equal to pressing @@ -1912,6 +1996,7 @@ DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \ " set virtio console\n") STEXI @item -virtioconsole @var{c} +@findex -virtioconsole Set virtio console. This option is maintained for backward compatibility. @@ -1923,6 +2008,7 @@ DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \ "-show-cursor show cursor\n") STEXI @item -show-cursor +@findex -show-cursor Show cursor. ETEXI @@ -1930,6 +2016,7 @@ DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \ "-tb-size n set TB size\n") STEXI @item -tb-size @var{n} +@findex -tb-size Set TB size. ETEXI @@ -1937,6 +2024,7 @@ DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ "-incoming p prepare for incoming migration, listen on port p\n") STEXI @item -incoming @var{port} +@findex -incoming Prepare for incoming migration, listen on @var{port}. ETEXI @@ -1944,6 +2032,7 @@ DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \ "-nodefaults don't create default devices\n") STEXI @item -nodefaults +@findex -nodefaults Don't create default devices. ETEXI @@ -1953,6 +2042,7 @@ DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \ #endif STEXI @item -chroot @var{dir} +@findex -chroot Immediately before starting guest execution, chroot to the specified directory. Especially useful in combination with -runas. ETEXI @@ -1963,6 +2053,7 @@ DEF("runas", HAS_ARG, QEMU_OPTION_runas, \ #endif STEXI @item -runas @var{user} +@findex -runas Immediately before starting guest execution, drop root privileges, switching to the specified user. ETEXI @@ -1974,6 +2065,7 @@ DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env, #endif STEXI @item -prom-env @var{variable}=@var{value} +@findex -prom-env Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only). ETEXI #if defined(TARGET_ARM) || defined(TARGET_M68K) @@ -1982,6 +2074,7 @@ DEF("semihosting", 0, QEMU_OPTION_semihosting, #endif STEXI @item -semihosting +@findex -semihosting Semihosting mode (ARM, M68K only). ETEXI #if defined(TARGET_ARM) @@ -1990,6 +2083,7 @@ DEF("old-param", 0, QEMU_OPTION_old_param, #endif STEXI @item -old-param +@findex -old-param (ARM) Old param mode (ARM only). ETEXI @@ -1997,6 +2091,7 @@ DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig, "-readconfig <file>\n") STEXI @item -readconfig @var{file} +@findex -readconfig Read device configuration from @var{file}. ETEXI DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig, @@ -2004,6 +2099,7 @@ DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig, " read/write config file\n") STEXI @item -writeconfig @var{file} +@findex -writeconfig Write device configuration to @var{file}. ETEXI DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig, @@ -2011,6 +2107,7 @@ DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig, " do not load default config files at startup\n") STEXI @item -nodefconfig +@findex -nodefconfig Normally QEMU loads a configuration file from @var{sysconfdir}/qemu.conf and @var{sysconfdir}/target-@var{ARCH}.conf on startup. The @code{-nodefconfig} option will prevent QEMU from loading these configuration files at startup. -- 1.6.5 ^ permalink raw reply related [flat|nested] 10+ messages in thread
* Re: [Qemu-devel] [PATCH 2/8] Documentation: Add direntry for info format 2010-02-05 22:51 ` [Qemu-devel] [PATCH 2/8] Documentation: Add direntry for info format Stefan Weil 2010-02-05 22:52 ` [Qemu-devel] [PATCH 3/8] Documentation: Use UTF-8 encoding and fix one wrong encoding Stefan Weil @ 2010-02-10 19:30 ` Anthony Liguori 1 sibling, 0 replies; 10+ messages in thread From: Anthony Liguori @ 2010-02-10 19:30 UTC (permalink / raw) To: Stefan Weil; +Cc: QEMU Developers On 02/05/2010 04:51 PM, Stefan Weil wrote: > update-info-dir maintains an index of all available > documentation in info format (the file /usr/share/info/dir). > > It reads special @direntry tags in info files. > > This patch (extracted from a larger patch provided by > Dirk Ullrich) adds these tags for qemu-doc.info and > qemu-tech.info. > > Signed-off-by: Stefan Weil<weil@mail.berlios.de> > Applied 2-8. I already picked up 1/8 when you submitted it separately. Thanks. Regards, Anthony Liguori > --- > qemu-doc.texi | 6 ++++++ > qemu-tech.texi | 6 ++++++ > 2 files changed, 12 insertions(+), 0 deletions(-) > > diff --git a/qemu-doc.texi b/qemu-doc.texi > index 2fb5c0b..eba6437 100644 > --- a/qemu-doc.texi > +++ b/qemu-doc.texi > @@ -6,6 +6,12 @@ > @paragraphindent 0 > @c %**end of header > > +@ifinfo > +@direntry > +* QEMU: (qemu-doc). The QEMU Emulator User Documentation. > +@end direntry > +@end ifinfo > + > @iftex > @titlepage > @sp 7 > diff --git a/qemu-tech.texi b/qemu-tech.texi > index 97d8dea..52560dc 100644 > --- a/qemu-tech.texi > +++ b/qemu-tech.texi > @@ -6,6 +6,12 @@ > @paragraphindent 0 > @c %**end of header > > +@ifinfo > +@direntry > +* QEMU Internals: (qemu-tech). The QEMU Emulator Internals. > +@end direntry > +@end ifinfo > + > @iftex > @titlepage > @sp 7 > ^ permalink raw reply [flat|nested] 10+ messages in thread
end of thread, other threads:[~2010-02-10 19:30 UTC | newest] Thread overview: 10+ messages (download: mbox.gz follow: Atom feed -- links below jump to the message on this page -- 2010-02-05 22:50 [Qemu-devel] [RFC] Documentation Stefan Weil 2010-02-05 22:51 ` [Qemu-devel] [PATCH 1/8] Documentation: Add build support for documentation in pdf format Stefan Weil 2010-02-05 22:51 ` [Qemu-devel] [PATCH 2/8] Documentation: Add direntry for info format Stefan Weil 2010-02-05 22:52 ` [Qemu-devel] [PATCH 3/8] Documentation: Use UTF-8 encoding and fix one wrong encoding Stefan Weil 2010-02-05 22:52 ` [Qemu-devel] [PATCH 4/8] Documentation: Add some basic documentation on make targets Stefan Weil 2010-02-05 22:52 ` [Qemu-devel] [PATCH 5/8] Documentation: Fix item list Stefan Weil 2010-02-05 22:52 ` [Qemu-devel] [PATCH 6/8] Documentation: Enhance documentation (index, keywords) Stefan Weil 2010-02-05 22:52 ` [Qemu-devel] [PATCH 7/8] Documentation: Add monitor commands to function index Stefan Weil 2010-02-05 22:52 ` [Qemu-devel] [PATCH 8/8] Documentation: Add command line options " Stefan Weil 2010-02-10 19:30 ` [Qemu-devel] [PATCH 2/8] Documentation: Add direntry for info format Anthony Liguori
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for NNTP newsgroup(s).