From nobody Tue Nov 26 11:45:13 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 205.139.110.120 as permitted sender) client-ip=205.139.110.120; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-1.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 205.139.110.120 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1575643902; cv=none; d=zohomail.com; s=zohoarc; b=RAkJj4q+ZIzEQ52TomDXgCGV3fZ9KN/sy8fiL0Hbr0gX1z2CQXbWq240Ets6Osi4iX0KSQc2Z/0SE39+8ysbDBX9PsPkd6KWbp/cNT8RujDs1b1T8lJSGQEq9kvpYcjoTslBLzr77deXFY33uke+VWh6I7p0yQWPlRl9Q7jysss= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1575643902; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=B3hXWqg7LfksU+kwuSzP5nPE/V3bsaKF5b4osvtAt48=; b=Zcukv1APtR8OPzpPQT4GM5O1HLN4wWhb/0J6zqv14+jcY94cORn6fGFxJ0mgZZ74mA2rQ296BwMY/7JFkT/M3iJXDingylW4oj6bQ0MEam/QZP+Jh/oIrvyIlQ7SLsGMaRLIoXojPYYMewdQsZjKk6nUfygSgLux0RT+dFGkXlQ= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 205.139.110.120 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-1.mimecast.com (us-smtp-delivery-1.mimecast.com [205.139.110.120]) by mx.zohomail.com with SMTPS id 1575643902379629.9033692392306; Fri, 6 Dec 2019 06:51:42 -0800 (PST) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-68-RBuDQ_5GMxyNlrrgoDjgYw-1; Fri, 06 Dec 2019 09:51:39 -0500 Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 88F1D800C78; Fri, 6 Dec 2019 14:51:32 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 5F0AB5C1D4; Fri, 6 Dec 2019 14:51:32 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id 1D66118034ED; Fri, 6 Dec 2019 14:51:32 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id xB6EpUoT017094 for ; Fri, 6 Dec 2019 09:51:30 -0500 Received: by smtp.corp.redhat.com (Postfix) id 4D4D25DA7B; Fri, 6 Dec 2019 14:51:30 +0000 (UTC) Received: from localhost.localdomain.com (ovpn-112-49.ams2.redhat.com [10.36.112.49]) by smtp.corp.redhat.com (Postfix) with ESMTP id 3EA685DA32; Fri, 6 Dec 2019 14:51:25 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1575643901; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=B3hXWqg7LfksU+kwuSzP5nPE/V3bsaKF5b4osvtAt48=; b=R3RFgt+Ny8kxuAdjP7rJv6SIyLl4J1Ce3p8IMU037cnAfHo+1Dr5kRzHIOJLSw6oEXpv5M 8dF8fipX3rnYuJDkTT7k/Di//tLx0pvzZYsDoXt/45Giyw7HItEBEqv0vyJ6YNUzw1UhH2 SKSesjqNBFOmhmyNtVtj+qcWQF7NHwo= From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: libvir-list@redhat.com Date: Fri, 6 Dec 2019 14:50:35 +0000 Message-Id: <20191206145042.3777845-11-berrange@redhat.com> In-Reply-To: <20191206145042.3777845-1-berrange@redhat.com> References: <20191206145042.3777845-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 X-loop: libvir-list@redhat.com Subject: [libvirt] [PATCH 10/17] docs: convert virt-pki-validate man page from pod to rst X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 X-MC-Unique: RBuDQ_5GMxyNlrrgoDjgYw-1 X-Mimecast-Spam-Score: 0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) 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=C3=A9 --- 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 =3D \ manpages/index.rst \ $(NULL) manpages1_rst =3D \ + manpages/virt-pki-validate.rst \ $(NULL) manpages7_rst =3D \ $(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 =3D=3D=3D=3D=3D =20 * `virt-host-validate(1) `__ - validate host virt= ualization setup +* `virt-pki-validate(1) `__ - validate libvirt PKI= files are configured correctly diff --git a/docs/manpages/virt-pki-validate.rst b/docs/manpages/virt-pki-v= alidate.rst new file mode 100644 index 0000000000..730c99ec79 --- /dev/null +++ b/docs/manpages/virt-pki-validate.rst @@ -0,0 +1,89 @@ +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +virt-pki-validate +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +--------------------------------------------------- +validate libvirt PKI files are configured correctly +--------------------------------------------------- + +:Manual section: 1 +:Manual group: Virtualization Support + +.. contents:: + +SYNOPSIS +=3D=3D=3D=3D=3D=3D=3D=3D + + +``virt-pki-validate`` [*OPTION*] + + +DESCRIPTION +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +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 +=3D=3D=3D=3D=3D=3D=3D + +``-h``, ``--help`` + +Display command line help usage then exit. + +``-V``, ``--version`` + +Display version information then exit. + +EXIT STATUS +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Upon successful validation, an exit status of 0 will be set. Upon +failure a non-zero status will be set. + + +AUTHOR +=3D=3D=3D=3D=3D=3D + +Richard Jones + + +BUGS +=3D=3D=3D=3D + +Please report all bugs you discover. This should be done via either: + +#. the mailing list + + `https://libvirt.org/contact.html `_ + +#. the bug tracker + + `https://libvirt.org/bugs.html `_ + +Alternatively, you may report bugs to your software distributor / vendor. + + +COPYRIGHT +=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Copyright (C) 2006-2012 by Red Hat, Inc. + + +LICENSE +=3D=3D=3D=3D=3D=3D=3D + +``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 +=3D=3D=3D=3D=3D=3D=3D=3D + +virsh(1), `online PKI setup instructions = `_, +`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 =3D \ PODFILES =3D \ 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 =3D \ MANINFILES =3D \ 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 =3D virt-xml-validate virt-pki-validate bin_PROGRAMS =3D virsh virt-admin libexec_SCRIPTS =3D libvirt-guests.sh man1_MANS =3D \ - 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 @@ -=3Dhead1 NAME - -virt-pki-validate - validate libvirt PKI files are configured correctly - -=3Dhead1 SYNOPSIS - -B [I