diff options
| author | Peter Maydell <peter.maydell@linaro.org> | 2020-02-28 15:36:15 +0000 |
|---|---|---|
| committer | Peter Maydell <peter.maydell@linaro.org> | 2020-03-06 11:06:55 +0000 |
| commit | d06118bfbd8c0ab5b665aee9e0561aa58d3e45e1 (patch) | |
| tree | 1a65003d58819aafb88b526a931782ef31fd06f9 /docs | |
| parent | bf87bef09197da1e25980438056f9494e1b7cb7d (diff) | |
| download | qemu-d06118bfbd8c0ab5b665aee9e0561aa58d3e45e1.zip qemu-d06118bfbd8c0ab5b665aee9e0561aa58d3e45e1.tar.gz qemu-d06118bfbd8c0ab5b665aee9e0561aa58d3e45e1.tar.bz2 | |
docs: Generate qemu.1 manpage with Sphinx
Generate the qemu.1 manpage using Sphinx; we do this with a new
top-level rst source file which is just the skeleton of the manpage
and which includes .rst.inc fragments where it needs to incorporate
sections from the larger HTML manuals.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
Tested-by: Alex Bennée <alex.bennee@linaro.org>
Message-id: 20200228153619.9906-30-peter.maydell@linaro.org
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/system/conf.py | 2 | ||||
| -rw-r--r-- | docs/system/qemu-manpage.rst | 45 |
2 files changed, 47 insertions, 0 deletions
diff --git a/docs/system/conf.py b/docs/system/conf.py index 23cab3f..6251849 100644 --- a/docs/system/conf.py +++ b/docs/system/conf.py @@ -17,6 +17,8 @@ html_theme_options['description'] = u'System Emulation User''s Guide' # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ + ('qemu-manpage', 'qemu', u'QEMU User Documentation', + ['Fabrice Bellard'], 1), ('qemu-block-drivers', 'qemu-block-drivers', u'QEMU block drivers reference', ['Fabrice Bellard and the QEMU Project developers'], 7), diff --git a/docs/system/qemu-manpage.rst b/docs/system/qemu-manpage.rst new file mode 100644 index 0000000..e9a25d0 --- /dev/null +++ b/docs/system/qemu-manpage.rst @@ -0,0 +1,45 @@ +: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. + +Title +===== + +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. |