mirror of
https://gitlab.com/libvirt/libvirt.git
synced 2024-10-22 05:59:18 +00:00
82d514084a
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>
96 lines
1.5 KiB
ReStructuredText
96 lines
1.5 KiB
ReStructuredText
===============
|
|
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/>`_
|