Documentation: Difference between revisions

From QEMU
 
(2 intermediate revisions by 2 users not shown)
Line 2: Line 2:


== How do I... ==
== How do I... ==
=== For users ===
=== For users ===
[[:Category:User documentation|All user documentation pages]]
[[:Category:User documentation|All user documentation pages]]
* [https://www.qemu.org/docs/master/ QEMU Main Documentation] (HTML generated from QEMU sources, updated frequently)
* [[Documentation/Networking|Set up Networking]]
* [[Documentation/Networking|Set up Networking]]
* [[Documentation/9psetup|Setting up VirtFS (9P Sharing over Virtio) between the guest and host]]
* [[Documentation/9psetup|Setting up VirtFS (9P Sharing over Virtio) between the guest and host]]
Line 23: Line 25:
* [[Documentation/Platforms/POWER|Running POWER / sPAPR / pseries guests on QEMU]]
* [[Documentation/Platforms/POWER|Running POWER / sPAPR / pseries guests on QEMU]]
* [[Documentation/Platforms/PowerPC|Running PowerPC Macintosh / Linux guests on QEMU]]
* [[Documentation/Platforms/PowerPC|Running PowerPC Macintosh / Linux guests on QEMU]]
* [[Documentation/Platforms/m68k|Running m68k Macintosh / Linux guests on QEMU]]
* [[Documentation/Platforms/SPARC|Running SPARC guests on QEMU]]
* [[Documentation/Platforms/SPARC|Running SPARC guests on QEMU]]
* [[Documentation/Platforms/Alpha|Running ALPHA guests on QEMU]]
* [[Documentation/Platforms/Alpha|Running ALPHA guests on QEMU]]
Line 33: Line 36:


=== For developers ===
=== For developers ===
[[:Category:Developer documentation|All developer documentation pages]]
 
* [[Documentation/GettingStartedDevelopers|Get started as a QEMU developer]]
* [[Documentation/Debugging|Debug QEMU]]
* [[Documentation/Debugging|Debug QEMU]]
* [[Documentation/GettingStartedDevelopers|Get started as a QEMU developer]]
* There is a "developer's guide" in docs/devel, though it has significant gaps. You can see a rendered version of it [https://qemu.readthedocs.io/en/latest/devel/index.html on readthedocs]
* The wiki has a list of [[:Category:Developer documentation|all wiki pages marked as developer documentation]]
 
Note that much of QEMU's internals are documented only in comments in the source code, or not at all.


== Technical Documentation ==
== Technical Documentation ==
Line 44: Line 51:


== External Sites ==
== External Sites ==
=== Manual ===
* [https://qemu.weilnetz.de/doc/qemu-doc.html QEMU Emulator User Documentation] (HTML generated from QEMU sources, updated frequently)
* [https://qemu.weilnetz.de/doc/qemu-ga-ref.html QEMU Guest Agent Protocol Reference] (HTML generated from QEMU sources)
* [https://qemu.weilnetz.de/doc/qemu-qmp-ref.html QEMU QMP Reference Manual] (HTML generated from QEMU sources)
(hosted courtesy of Stefan Weil)


=== Other efforts ===
=== Other efforts ===


* [http://en.wikibooks.org/wiki/QEMU QEMU documentation] on wikibooks.org
* [http://en.wikibooks.org/wiki/QEMU QEMU documentation] on wikibooks.org
* [http://qemu-buch.de/ QEMU-Buch / QEMU-Book] - a quite versatile book on qemu, provided in German and English (partly as a google translation), its describing e.g. lots of guests and hosts
* [https://web.archive.org/web/20140501153642/http://qemu-buch.de/e/Content QEMU-Buch / QEMU-Book] - A quite versatile book on QEMU, provided in German and English (partly as a google translation), but likely rather outdated nowadays.


=== Blogs ===
=== Blogs ===

Latest revision as of 07:28, 9 January 2023

The QEMU website has a Documentation page with pointers to the current actively maintained documentation including rendered versions of the user manual and selection of the developer documentation. More free form documentation can be found here on the wiki.

How do I...

For users

All user documentation pages

Building QEMU from source:

For users that target for a specific platform:

For developers

Note that much of QEMU's internals are documented only in comments in the source code, or not at all.

Technical Documentation

External Sites

Other efforts

Blogs

All Documentation Pages on Wiki