We don't usually provide manual pages for internal tools,
but in the case of virt-ssh-helper the command is installed
inside the default $PATH and so it's likely that the user
will stumble upon it by using the shell's completion feature
when invoking another virt-* command, which makes it a good
idea to provide at least a minimal manual page.
Signed-off-by: Andrea Bolognani <abologna@xxxxxxxxxx>
---
docs/manpages/meson.build | 1 +
docs/manpages/virt-ssh-helper.rst | 95 +++++++++++++++++++++++++++++++
libvirt.spec.in | 1 +
3 files changed, 97 insertions(+)
create mode 100644 docs/manpages/virt-ssh-helper.rst
diff --git a/docs/manpages/meson.build b/docs/manpages/meson.build
index d8077f0b61..bf6fc730e0 100644
--- a/docs/manpages/meson.build
+++ b/docs/manpages/meson.build
@@ -19,6 +19,7 @@ docs_man_files = [
{ '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 },
{ 'name': 'virt-xml-validate', 'section': '1', 'install': true },
{ 'name': 'libvirtd', 'section': '8', 'install': conf.has('WITH_LIBVIRTD') },
diff --git a/docs/manpages/virt-ssh-helper.rst b/docs/manpages/virt-ssh-helper.rst
new file mode 100644
index 0000000000..175ddacaec
--- /dev/null
+++ b/docs/manpages/virt-ssh-helper.rst
@@ -0,0 +1,95 @@
+===============
+virt-ssh-helper
+===============
+
+--------------------
+libvirt socket proxy
+--------------------
+
+:Manual section: 1
+:Manual group: Virtualization Support
+
+.. contents::
+
+
+SYNOPSIS
+========
+
+``virt-ssh-helper`` [*OPTION*]... *URI*
+
+
+DESCRIPTION
+===========
+
+``virt-ssh-helper`` is an internal tool used to handle connections
+coming from remote clients, and it's not intended to be called
+directly by the user.
+
+
+OPTIONS
+=======
+
+*URI*
+
+Local libvirt URI to connect the remote client to.
+
+``-r``, ``--readonly``
+
+Make the connection read-only.
+
+``-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
+======
+
+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) 2020 Red Hat, Inc.
+
+
+LICENSE
+=======
+
+``virt-ssh-helper`` is distributed under the terms of the GNU LGPL 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), `https://libvirt.org/ <https://libvirt.org/>`_
diff --git a/libvirt.spec.in b/libvirt.spec.in
index 32b4243d0a..352908642c 100644
--- a/libvirt.spec.in
+++ b/libvirt.spec.in
@@ -1697,6 +1697,7 @@ exit 0
%{_mandir}/man1/virt-admin.1*
%{_mandir}/man1/virt-host-validate.1*
+%{_mandir}/man1/virt-ssh-helper.1*
%{_mandir}/man8/libvirtd.8*
%{_mandir}/man8/virtlogd.8*
%{_mandir}/man8/virtlockd.8*
--
2.31.1
