xemu/docs/system/qemu-manpage.rst
Paolo Bonzini f0c1507a2b docs/system: standardize man page sections to --- with overline
Man pages in docs/system use file inclusion heavily.  Use headings with
overlines in the main files, so that the same included file work well
from both manuals and man pages.

This style of heading is a bit more heavy-weight, so it is not used by
the other man pages in interop/ and tools/.  If in the future they
are changed to use include files, for example to avoid having sections
named "synopsis" or "description", they can switch to --- with overline
as well.

Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
2021-09-13 13:56:26 +02:00

52 lines
869 B
ReStructuredText

:orphan:
..
This file is the skeleton for the qemu.1 manpage. It mostly
should simply include the .rst.inc files corresponding to the
parts of the documentation that go in the manpage as well as the
HTML manual.
=======================
QEMU User Documentation
=======================
--------
Synopsis
--------
.. parsed-literal::
|qemu_system| [options] [disk_image]
-----------
Description
-----------
.. include:: target-i386-desc.rst.inc
-------
Options
-------
disk_image is a raw hard disk image for IDE hard disk 0. Some targets do
not need a disk image.
.. hxtool-doc:: qemu-options.hx
.. include:: keys.rst.inc
.. include:: mux-chardev.rst.inc
-----
Notes
-----
.. include:: device-url-syntax.rst.inc
--------
See also
--------
The HTML documentation of QEMU for more precise information and Linux
user mode emulator invocation.