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
c07ef7c563
libvirt/docs/manpages/index.rst

39 lines
1.7 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
Daemons
=======
* `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: 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
qemu: introduce a new "virt-qemu-run" program The previous "QEMU shim" proof of concept was taking an approach of only caring about initial spawning of the QEMU process. It was then registered with the libvirtd daemon who took over management of it. The intent was that later libvirtd would be refactored so that the shim retained control over the QEMU monitor and libvirt just forwarded APIs to each shim as needed. This forwarding of APIs would require quite alot of significant refactoring of libvirtd to achieve. This impl thus takes a quite different approach, explicitly deciding to keep the VMs completely separate from those seen & managed by libvirtd. Instead it uses the new "qemu:///embed" URI scheme to embed the entire QEMU driver in the shim, running with a custom root directory. Once the driver is initialization, the shim starts a VM and then waits to shutdown automatically when QEMU shuts down, or should kill QEMU if it is terminated itself. This ought to use the AUTO_DESTROY feature but that is not yet available in embedded mode, so we rely on installing a few signal handlers to gracefully kill QEMU. This isn't reliable if we crash of course, but you can restart with the same root dir. Note this program does not expose any way to manage the QEMU process, since there's no RPC interface enabled. It merely starts the VM and cleans up when the guest shuts down at the end. This program is installed to /usr/bin/virt-qemu-run enabling direct use by end users. Most use cases will probably want to integrate the concept directly into their respective application codebases. This standalone binary serves as a nice demo though, and also provides a way to measure performance of the startup process quite simply. Reviewed-by: Michal Privoznik <mprivozn@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-05-17 12:01:59 +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