shaba/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2025-01-07 21:17:55 +03:00
Code Releases Activity
8618535990
libvirt/docs/manpages/virt-ssh-helper.rst

96 lines
1.5 KiB
ReStructuredText
Raw Normal View History

virt-ssh-helper: Add manual page 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@redhat.com> Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
2021-12-10 17:56:29 +03:00
===============
virt-ssh-helper
===============
--------------------
libvirt socket proxy
--------------------
virt-ssh-helper: Move manual page to section 8 While sections are somewhat loosely defined and thus the choice is not quite a clear-cut one, section 8 might be a slightly better fit in this case. Suggested-by: Olaf Hering <olaf@aepfle.de> Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com>
2022-01-13 16:42:21 +03:00
:Manual section: 8
virt-ssh-helper: Add manual page 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@redhat.com> Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
2021-12-10 17:56:29 +03:00
: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/>`_
Copy Permalink