提交 c9ef27df 编写于 作者: D Daniel P. Berrangé

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: NCole Robinson <crobinso@redhat.com>
Signed-off-by: NDaniel P. Berrangé <berrange@redhat.com>
上级 9f050677
...@@ -201,6 +201,7 @@ manpages_rst = \ ...@@ -201,6 +201,7 @@ manpages_rst = \
manpages/index.rst \ manpages/index.rst \
$(NULL) $(NULL)
manpages1_rst = \ manpages1_rst = \
manpages/virt-pki-validate.rst \
$(NULL) $(NULL)
manpages7_rst = \ manpages7_rst = \
$(NULL) $(NULL)
......
...@@ -13,3 +13,4 @@ Tools ...@@ -13,3 +13,4 @@ Tools
===== =====
* `virt-host-validate(1) <virt-host-validate.html>`__ - validate host virtualization setup * `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
=head1 NAME =================
virt-pki-validate
=================
virt-pki-validate - validate libvirt PKI files are configured correctly ---------------------------------------------------
validate libvirt PKI files are configured correctly
---------------------------------------------------
=head1 SYNOPSIS :Manual section: 1
:Manual group: Virtualization Support
B<virt-pki-validate> [I<OPTION>] .. contents::
=head1 DESCRIPTION SYNOPSIS
========
``virt-pki-validate`` [*OPTION*]
DESCRIPTION
===========
This tool validates that the necessary PKI files are configured for This tool validates that the necessary PKI files are configured for
a secure libvirt server or client using the TLS encryption protocol. a secure libvirt server or client using the TLS encryption protocol.
It will report any missing certificate or key files on the host. It 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 should be run as root to ensure it can read all the necessary files
=head1 OPTIONS
=over OPTIONS
=======
=item B<-h, --help> ``-h``, ``--help``
Display command line help usage then exit. Display command line help usage then exit.
=item B<-V, --version> ``-V``, ``--version``
Display version information then exit. Display version information then exit.
=back EXIT STATUS
===========
=head1 EXIT STATUS
Upon successful validation, an exit status of 0 will be set. Upon Upon successful validation, an exit status of 0 will be set. Upon
failure a non-zero status will be set. failure a non-zero status will be set.
=head1 AUTHOR
AUTHOR
======
Richard Jones Richard Jones
=head1 BUGS
Report any bugs discovered to the libvirt community via the BUGS
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. Please report all bugs you discover. This should be done via either:
=head1 COPYRIGHT #. 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. Copyright (C) 2006-2012 by Red Hat, Inc.
=head1 LICENSE
virt-pki-validate is distributed under the terms of the GNU GPL v2+. 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 This is free software; see the source for copying conditions. There
is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE PURPOSE
=head1 SEE ALSO
L<virsh(1)>, online PKI setup instructions L<https://libvirt.org/remote.html> SEE ALSO
========
=cut virsh(1), `online PKI setup instructions <https://libvirt.org/remote.html>`_,
`https://www.libvirt.org/ <https://www.libvirt.org/>`_
...@@ -55,7 +55,6 @@ ICON_FILES = \ ...@@ -55,7 +55,6 @@ ICON_FILES = \
PODFILES = \ PODFILES = \
virt-admin.pod \ virt-admin.pod \
virt-login-shell.pod \ virt-login-shell.pod \
virt-pki-validate.pod \
virt-sanlock-cleanup.pod \ virt-sanlock-cleanup.pod \
virt-xml-validate.pod \ virt-xml-validate.pod \
virsh.pod \ virsh.pod \
...@@ -64,7 +63,6 @@ PODFILES = \ ...@@ -64,7 +63,6 @@ PODFILES = \
MANINFILES = \ MANINFILES = \
virt-admin.1.in \ virt-admin.1.in \
virt-login-shell.1.in \ virt-login-shell.1.in \
virt-pki-validate.1.in \
virt-sanlock-cleanup.8.in \ virt-sanlock-cleanup.8.in \
virt-xml-validate.1.in \ virt-xml-validate.1.in \
virsh.1.in \ virsh.1.in \
...@@ -96,7 +94,6 @@ bin_SCRIPTS = virt-xml-validate virt-pki-validate ...@@ -96,7 +94,6 @@ bin_SCRIPTS = virt-xml-validate virt-pki-validate
bin_PROGRAMS = virsh virt-admin bin_PROGRAMS = virsh virt-admin
libexec_SCRIPTS = libvirt-guests.sh libexec_SCRIPTS = libvirt-guests.sh
man1_MANS = \ man1_MANS = \
virt-pki-validate.1 \
virt-xml-validate.1 \ virt-xml-validate.1 \
virsh.1 \ virsh.1 \
virt-admin.1 virt-admin.1
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册