External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-08-07 09:19:19 +00:00
Code Issues Packages Projects Releases Wiki Activity
b7e9fefcae
libvirt/docs/manpages/index.rst

50 lines
2.1 KiB
ReStructuredText
Raw Normal View History

docs: introduce rst2man as a mandatory tool for building docs The rst2man tool is provided by python docutils, and as the name suggests, it converts RST documents into man pages. The intention is that our current POD docs will be converted to RST format, allowing one more use of Perl to be eliminated from libvirt. The manual pages will now all be kept in the docs/manpages/ directory, which enables us to include the man pages in the published website. This is good for people searching for libvirt man pages online as it makes it more likely google will send them to the libvirt.org instead of some random third party man page site with outdated content. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 13:18:36 +00:00
====================
Libvirt Manual Pages
====================
docs: convert libvirtd man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 14:29:47 +00:00
docs: tweak heading for daemon manual pages This group will be distinct from the per-driver modular daemon mapages. Reviewed-by: Jiri Denemark <jdenemar@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2020-11-17 15:12:05 +00:00
Common Daemons
==============
These daemons provide functionality across multiple libvirt drivers
docs: convert libvirtd man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 14:29:47 +00:00
* `libvirtd(8) <libvirtd.html>`__ - libvirt management daemon
docs: convert virtlockd man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 14:29:47 +00:00
* `virtlockd(8) <virtlockd.html>`__ - libvirt lock management daemon
docs: convert virtlogd man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 14:29:47 +00:00
* `virtlogd(8) <virtlogd.html>`__ - libvirt log management daemon
docs: add manpage for virtproxyd This is an adaptation of the libvirtd manpage. Reviewed-by: Jiri Denemark <jdenemar@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2020-09-24 14:08:37 +00:00
* `virtproxyd(8) <virtproxyd.html>`__ - libvirt proxy daemon
docs: convert virt-host-validate man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 14:29:47 +00:00
docs: add manpage for virtbhyved This is an adaptation of the libvirtd manpage. Reviewed-by: Jiri Denemark <jdenemar@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2020-09-24 14:08:37 +00:00
Modular Driver daemons
======================
These daemons provide functionality to a single libvirt driver
* `virtbhyved(8) <virtbhyved.html>`__ - libvirt bhyve management daemon
docs: add manpage for virtinterfaced This is an adaptation of the libvirtd manpage. Reviewed-by: Jiri Denemark <jdenemar@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2020-09-24 14:08:37 +00:00
* `virtinterfaced(8) <virtinterfaced.html>`__ - libvirt host network interface management daemon
docs: add manpage for virtbhyved This is an adaptation of the libvirtd manpage. Reviewed-by: Jiri Denemark <jdenemar@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2020-09-24 14:08:37 +00:00
docs: convert virt-host-validate man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 14:29:47 +00:00
Tools
=====
* `virt-host-validate(1) <virt-host-validate.html>`__ - validate host virtualization setup
docs: convert virt-pki-validate man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 14:29:47 +00:00
* `virt-pki-validate(1) <virt-pki-validate.html>`__ - validate libvirt PKI files are configured correctly
docs: convert virt-xml-validate man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 14:29:47 +00:00
* `virt-xml-validate(1) <virt-xml-validate.html>`__ - validate libvirt XML files against a schema
docs: convert virt-sanlock-cleanup man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 14:29:47 +00:00
* `virt-sanlock-cleanup(8) <virt-sanlock-cleanup.html>`__ - remove stale sanlock resource lease files
docs: convert virt-login-shell man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 14:29:47 +00:00
* `virt-login-shell(1) <virt-login-shell.html>`__ - tool to execute a shell within a container
docs: convert virt-admin man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 14:29:47 +00:00
* `virt-admin(1) <virt-admin.html>`__ - daemon administration interface
docs: convert virsh man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 14:29:47 +00:00
* `virsh(1) <virsh.html>`__ - management user interface
docs: Fix link to virt-qemu-run(1) Signed-off-by: Andrea Bolognani <abologna@redhat.com>
2020-01-27 16:47:02 +00:00
* `virt-qemu-run(1) <virt-qemu-run.html>`__ - run standalone QEMU instances
docs: convert virkeycode*/virkeyname* man pages from pod to rst The keycodemap tool is told to generate docs in rst format now instead of pod. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 14:29:47 +00:00
Key codes
=========
* `virkeycode-atset1 <virkeycode-atset1.html>`__ - atset1 keycodes
* `virkeycode-atset2 <virkeycode-atset2.html>`__ - atset2 keycodes
* `virkeycode-atset3 <virkeycode-atset3.html>`__ - atset3 keycodes
* `virkeycode-linux <virkeycode-linux.html>`__ - linux keycodes
* `virkeycode-qnum <virkeycode-qnum.html>`__ - qnmum keycodes
* `virkeycode-osx <virkeycode-osx.html>`__ - osx keycodes
* `virkeycode-usb <virkeycode-usb.html>`__ - usb keycodes
* `virkeycode-win32 <virkeycode-win32.html>`__ - win32 keycodes
* `virkeycode-xtkbd <virkeycode-xtkbd.html>`__ - xtkbd keycodes
* `virkeyname-linux <virkeyname-linux.html>`__ - keycodes
* `virkeyname-osx <virkeyname-osx.html>`__ - osx keynames
* `virkeyname-win32 <virkeyname-win32.html>`__ - win32 keynames
Reference in New Issue Copy Permalink