]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
virt-pki-query-dn: Add manual page
authorAndrea Bolognani <abologna@redhat.com>
Thu, 9 Dec 2021 17:36:34 +0000 (18:36 +0100)
committerAndrea Bolognani <abologna@redhat.com>
Fri, 10 Dec 2021 17:40:10 +0000 (18:40 +0100)
Signed-off-by: Andrea Bolognani <abologna@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>
docs/manpages/meson.build
docs/manpages/virt-pki-query-dn.rst [new file with mode: 0644]
libvirt.spec.in

index e80fff48c8939612be0653cde38a682c9042abc5..bf6fc730e0ce6e59d5197952f7bb6c8ce970f21a 100644 (file)
@@ -16,6 +16,7 @@ docs_man_files = [
   { 'name': 'virt-admin', 'section': '1', 'install': true },
   { 'name': 'virt-host-validate', 'section': '1', 'install': conf.has('WITH_HOST_VALIDATE') },
   { 'name': 'virt-login-shell', 'section': '1', 'install': conf.has('WITH_LOGIN_SHELL') },
+  { 'name': 'virt-pki-query-dn', 'section': '1', 'install': true },
   { 'name': 'virt-pki-validate', 'section': '1', 'install': true },
   { 'name': 'virt-qemu-run', 'section': '1', 'install': conf.has('WITH_QEMU') },
   { 'name': 'virt-ssh-helper', 'section': '1', 'install': true },
diff --git a/docs/manpages/virt-pki-query-dn.rst b/docs/manpages/virt-pki-query-dn.rst
new file mode 100644 (file)
index 0000000..bf809df
--- /dev/null
@@ -0,0 +1,90 @@
+=================
+virt-pki-query-dn
+=================
+
+-------------------------------------------------
+extract Distinguished Name from a PEM certificate
+-------------------------------------------------
+
+:Manual section: 1
+:Manual group: Virtualization Support
+
+.. contents::
+
+
+SYNOPSIS
+========
+
+``virt-pki-query-dn`` [*OPTION*]... *FILE*
+
+
+DESCRIPTION
+===========
+
+Extract Distinguished Name from a PEM certificate.
+
+The output is meant to be used in the ``tls_allowed_dn_list``
+configuration option in the ``libvirtd.conf`` file.
+
+
+OPTIONS
+=======
+
+``-h``, ``--help``
+
+Display command line help usage then exit.
+
+``-V``, ``--version``
+
+Display version information then exit.
+
+
+EXIT STATUS
+===========
+
+The exit status will be zero on success, non-zero on failure.
+
+
+AUTHOR
+======
+
+Martin Kletzander
+
+
+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) 2021 Red Hat, Inc.
+
+
+LICENSE
+=======
+
+``virt-pki-query-dn`` 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),
+`online PKI setup instructions <https://libvirt.org/remote.html>`_,
+`https://www.libvirt.org/ <https://www.libvirt.org/>`_
index 592a67f061a14c0a4a402f77b6cea77c62fd2060..352908642cff973ac06f06bc3eada03fb97446fa 100644 (file)
@@ -1987,6 +1987,7 @@ exit 0
 %files client
 %{_mandir}/man1/virsh.1*
 %{_mandir}/man1/virt-xml-validate.1*
+%{_mandir}/man1/virt-pki-query-dn.1*
 %{_mandir}/man1/virt-pki-validate.1*
 %{_bindir}/virsh
 %{_bindir}/virt-xml-validate