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. Signed-off-by: Daniel P. Berrangé <berrange@xxxxxxxxxx> --- docs/Makefile.am | 5 ++ docs/manpages/index.rst | 5 ++ docs/manpages/virt-host-validate.rst | 95 ++++++++++++++++++++++++++++ tools/Makefile.am | 3 - tools/virt-host-validate.pod | 68 -------------------- 5 files changed, 105 insertions(+), 71 deletions(-) create mode 100644 docs/manpages/virt-host-validate.rst delete mode 100644 tools/virt-host-validate.pod diff --git a/docs/Makefile.am b/docs/Makefile.am index 9fa706f0a9..bedcc04bd4 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -224,6 +224,11 @@ manpages_rst += \ manpages/virtlogd.rst \ $(NULL) endif ! WITH_LIBVIRTD +if WITH_HOST_VALIDATE + manpages8_rst += manpages/virt-host-validate.rst +else ! WITH_HOST_VALIDATE + manpages_rst += manpages/virt-host-validate.rst +endif ! WITH_HOST_VALIDATE manpages_rst_html_in = \ $(manpages_rst:%.rst=%.html.in) manpages_html = \ diff --git a/docs/manpages/index.rst b/docs/manpages/index.rst index 8544fb2501..a545960919 100644 --- a/docs/manpages/index.rst +++ b/docs/manpages/index.rst @@ -8,3 +8,8 @@ Daemons * `libvirtd(8) <libvirtd.html>`__ - libvirt management daemon * `virtlockd(8) <virtlockd.html>`__ - libvirt lock management daemon * `virtlogd(8) <virtlogd.html>`__ - libvirt log management daemon + +Tools +===== + +* `virt-host-validate(1) <virt-host-validate.html>`__ - validate host virtualization setup diff --git a/docs/manpages/virt-host-validate.rst b/docs/manpages/virt-host-validate.rst new file mode 100644 index 0000000000..0738694662 --- /dev/null +++ b/docs/manpages/virt-host-validate.rst @@ -0,0 +1,95 @@ +================== +virt-host-validate +================== + +---------------------------------- +validate host virtualization setup +---------------------------------- + +:Manual section: 1 +:Manual group: Virtualization Support + +.. contents:: + +SYNOPSIS +======== + +``virt-host-validate`` [*OPTIONS*...] [*HV-TYPE*] + + +DESCRIPTION +=========== + +This tool validates that the host is configured in a suitable +way to run libvirt hypervisor drivers. If invoked without any +arguments it will check support for all hypervisor drivers it +is aware of. Optionally it can be given a particular hypervisor +type (``qemu``, ``lxc`` or ``bhyve``) to restrict the checks +to those relevant for that virtualization technology + + +OPTIONS +======= + +``-v``, ``--version`` + +Display the command version + +``-h``, ``--help`` + +Display the command line help + +``-q``, ``--quiet`` + +Don't display details of individual checks being performed. +Only display output if a check does not pass. + + +EXIT STATUS +=========== + +Upon successful validation, an exit status of 0 will be set. Upon +failure a non-zero status will be set. + +AUTHOR +====== + +Daniel P. Berrangé + + +BUGS +==== + +Please report all bugs you discover. This should be done via either: + +#. the mailing list + + `https://libvirt.org/contact.html <https://libvirt.org/contact.html>`_ + +#. the bug tracker + + `https://libvirt.org/bugs.html <https://libvirt.org/bugs.html>`_ + +Alternatively, you may report bugs to your software distributor / vendor. + + +COPYRIGHT +========= + +Copyright (C) 2012 by Red Hat, Inc. + + +LICENSE +======= + +``virt-host-validate`` is distributed under the terms of the GNU GPL v2+. +This is free software; see the source for copying conditions. There +is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR +PURPOSE + + +SEE ALSO +======== + +virsh(1), virt-pki-validate(1), virt-xml-validate(1), +`https://libvirt.org/ <https://libvirt.org/>`_ diff --git a/tools/Makefile.am b/tools/Makefile.am index 1a541a3984..f4e71d38f2 100644 --- a/tools/Makefile.am +++ b/tools/Makefile.am @@ -54,7 +54,6 @@ ICON_FILES = \ PODFILES = \ virt-admin.pod \ - virt-host-validate.pod \ virt-login-shell.pod \ virt-pki-validate.pod \ virt-sanlock-cleanup.pod \ @@ -64,7 +63,6 @@ PODFILES = \ MANINFILES = \ virt-admin.1.in \ - virt-host-validate.1.in \ virt-login-shell.1.in \ virt-pki-validate.1.in \ virt-sanlock-cleanup.8.in \ @@ -118,7 +116,6 @@ endif WITH_LOGIN_SHELL if WITH_HOST_VALIDATE bin_PROGRAMS += virt-host-validate -man1_MANS += virt-host-validate.1 endif WITH_HOST_VALIDATE virt-xml-validate: virt-xml-validate.in Makefile diff --git a/tools/virt-host-validate.pod b/tools/virt-host-validate.pod deleted file mode 100644 index 121bb7ed7a..0000000000 --- a/tools/virt-host-validate.pod +++ /dev/null @@ -1,68 +0,0 @@ -=head1 NAME - -virt-host-validate - validate host virtualization setup - -=head1 SYNOPSIS - -B<virt-host-validate> [I<OPTIONS>...] [I<HV-TYPE>] - -=head1 DESCRIPTION - -This tool validates that the host is configured in a suitable -way to run libvirt hypervisor drivers. If invoked without any -arguments it will check support for all hypervisor drivers it -is aware of. Optionally it can be given a particular hypervisor -type ('qemu', 'lxc' or 'bhyve') to restrict the checks -to those relevant for that virtualization technology - -=head1 OPTIONS - -=over 4 - -=item C<-v>, C<--version> - -Display the command version - -=item C<-h>, C<--help> - -Display the command line help - -=item C<-q>, C<--quiet> - -Don't display details of individual checks being performed. -Only display output if a check does not pass. - -=back - -=head1 EXIT STATUS - -Upon successful validation, an exit status of 0 will be set. Upon -failure a non-zero status will be set. - -=head1 AUTHOR - -Daniel P. Berrange - -=head1 BUGS - -Report any bugs discovered to the libvirt community via the -mailing list L<https://libvirt.org/contact.html> or bug tracker -L<https://libvirt.org/bugs.html>. -Alternatively report bugs to your software distributor / vendor. - -=head1 COPYRIGHT - -Copyright (C) 2012 by Red Hat, Inc. - -=head1 LICENSE - -virt-host-validate is distributed under the terms of the GNU GPL v2+. -This is free software; see the source for copying conditions. There -is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR -PURPOSE - -=head1 SEE ALSO - -L<virsh(1)>, L<virt-pki-validate(1)>, L<virt-xml-validate(1)> - -=cut -- 2.23.0 -- libvir-list mailing list libvir-list@xxxxxxxxxx https://www.redhat.com/mailman/listinfo/libvir-list
