[libvirt] [PATCH 10/17] docs: convert virt-pki-validate man page from pod to rst
Daniel P. Berrangé
berrange at redhat.com
Fri Dec 6 14:50:35 UTC 2019
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 at redhat.com>
---
docs/Makefile.am | 1 +
docs/manpages/index.rst | 1 +
docs/manpages/virt-pki-validate.rst | 89 +++++++++++++++++++++++++++++
tools/Makefile.am | 3 -
tools/virt-pki-validate.pod | 61 --------------------
5 files changed, 91 insertions(+), 64 deletions(-)
create mode 100644 docs/manpages/virt-pki-validate.rst
delete mode 100644 tools/virt-pki-validate.pod
diff --git a/docs/Makefile.am b/docs/Makefile.am
index bedcc04bd4..a5e85390a4 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -201,6 +201,7 @@ manpages_rst = \
manpages/index.rst \
$(NULL)
manpages1_rst = \
+ manpages/virt-pki-validate.rst \
$(NULL)
manpages7_rst = \
$(NULL)
diff --git a/docs/manpages/index.rst b/docs/manpages/index.rst
index a545960919..0d166c1923 100644
--- a/docs/manpages/index.rst
+++ b/docs/manpages/index.rst
@@ -13,3 +13,4 @@ Tools
=====
* `virt-host-validate(1) <virt-host-validate.html>`__ - validate host virtualization setup
+* `virt-pki-validate(1) <virt-pki-validate.html>`__ - validate libvirt PKI files are configured correctly
diff --git a/docs/manpages/virt-pki-validate.rst b/docs/manpages/virt-pki-validate.rst
new file mode 100644
index 0000000000..730c99ec79
--- /dev/null
+++ b/docs/manpages/virt-pki-validate.rst
@@ -0,0 +1,89 @@
+=================
+virt-pki-validate
+=================
+
+---------------------------------------------------
+validate libvirt PKI files are configured correctly
+---------------------------------------------------
+
+:Manual section: 1
+:Manual group: Virtualization Support
+
+.. contents::
+
+SYNOPSIS
+========
+
+
+``virt-pki-validate`` [*OPTION*]
+
+
+DESCRIPTION
+===========
+
+This tool validates that the necessary PKI files are configured for
+a secure libvirt server or client using the TLS encryption protocol.
+It will report any missing certificate or key files on the host. It
+should be run as root to ensure it can read all the necessary files
+
+
+OPTIONS
+=======
+
+``-h``, ``--help``
+
+Display command line help usage then exit.
+
+``-V``, ``--version``
+
+Display version information then exit.
+
+EXIT STATUS
+===========
+
+Upon successful validation, an exit status of 0 will be set. Upon
+failure a non-zero status will be set.
+
+
+AUTHOR
+======
+
+Richard Jones
+
+
+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) 2006-2012 by Red Hat, Inc.
+
+
+LICENSE
+=======
+
+``virt-pki-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), `online PKI setup instructions <https://libvirt.org/remote.html>`_,
+`https://www.libvirt.org/ <https://www.libvirt.org/>`_
diff --git a/tools/Makefile.am b/tools/Makefile.am
index f4e71d38f2..db690670af 100644
--- a/tools/Makefile.am
+++ b/tools/Makefile.am
@@ -55,7 +55,6 @@ ICON_FILES = \
PODFILES = \
virt-admin.pod \
virt-login-shell.pod \
- virt-pki-validate.pod \
virt-sanlock-cleanup.pod \
virt-xml-validate.pod \
virsh.pod \
@@ -64,7 +63,6 @@ PODFILES = \
MANINFILES = \
virt-admin.1.in \
virt-login-shell.1.in \
- virt-pki-validate.1.in \
virt-sanlock-cleanup.8.in \
virt-xml-validate.1.in \
virsh.1.in \
@@ -96,7 +94,6 @@ bin_SCRIPTS = virt-xml-validate virt-pki-validate
bin_PROGRAMS = virsh virt-admin
libexec_SCRIPTS = libvirt-guests.sh
man1_MANS = \
- virt-pki-validate.1 \
virt-xml-validate.1 \
virsh.1 \
virt-admin.1
diff --git a/tools/virt-pki-validate.pod b/tools/virt-pki-validate.pod
deleted file mode 100644
index 5d44973fdc..0000000000
--- a/tools/virt-pki-validate.pod
+++ /dev/null
@@ -1,61 +0,0 @@
-=head1 NAME
-
-virt-pki-validate - validate libvirt PKI files are configured correctly
-
-=head1 SYNOPSIS
-
-B<virt-pki-validate> [I<OPTION>]
-
-=head1 DESCRIPTION
-
-This tool validates that the necessary PKI files are configured for
-a secure libvirt server or client using the TLS encryption protocol.
-It will report any missing certificate or key files on the host. It
-should be run as root to ensure it can read all the necessary files
-
-=head1 OPTIONS
-
-=over
-
-=item B<-h, --help>
-
-Display command line help usage then exit.
-
-=item B<-V, --version>
-
-Display version information then exit.
-
-=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
-
-Richard Jones
-
-=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) 2006-2012 by Red Hat, Inc.
-
-=head1 LICENSE
-
-virt-pki-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)>, online PKI setup instructions L<https://libvirt.org/remote.html>
-
-=cut
--
2.23.0
More information about the libvir-list
mailing list