libvirt/docs/manpages/virtvboxd.rst
Ján Tomko f65c9d83ab docs: clarify --timeout description for split daemons
Remove the reference to "running domains" for daemons that happily
exit while domains are running.

https://bugzilla.redhat.com/show_bug.cgi?id=2035985

Signed-off-by: Ján Tomko <jtomko@redhat.com>
Reviewed-by: Andrea Bolognani <abologna@redhat.com>
2023-03-15 17:23:18 +01:00

214 lines
4.7 KiB
ReStructuredText

=========
virtvboxd
=========
------------------------------------
libvirt VirtualBox management daemon
------------------------------------
:Manual section: 8
:Manual group: Virtualization Support
.. contents::
SYNOPSIS
========
``virtvboxd`` [*OPTION*]...
DESCRIPTION
===========
The ``virtvboxd`` program is a server side daemon component of the libvirt
virtualization management system.
It is one of a collection of modular daemons that replace functionality
previously provided by the monolithic ``libvirtd`` daemon.
This daemon runs on virtualization hosts to provide management for VirtualBox
virtual machines.
The ``virtvboxd`` daemon only listens for requests on a local Unix domain
socket. Remote off-host access and backwards compatibility with legacy
clients expecting ``libvirtd`` is provided by the ``virtproxy`` daemon.
Restarting ``virtvboxd`` does not interrupt running guests. Guests continue to
operate and changes in their state will generally be picked up automatically
during startup.
DAEMON STARTUP MODES
====================
The ``virtvboxd`` daemon is capable of starting in two modes.
Socket activation mode
----------------------
On hosts with systemd it is started in socket activation mode and it will rely
on systemd to create and listen on the UNIX sockets and pass them as pre-opened
file descriptors. In this mode most of the socket related config options in
``/etc/libvirt/virtvboxd.conf`` will no longer have any effect.
Traditional service mode
------------------------
On hosts without systemd, it will create and listen on UNIX sockets itself.
OPTIONS
=======
``-h``, ``--help``
Display command line help usage then exit.
``-d``, ``--daemon``
Run as a daemon & write PID file.
``-f``, ``--config *FILE*``
Use this configuration file, overriding the default value.
``-p``, ``--pid-file *FILE*``
Use this name for the PID file, overriding the default value.
``-t``, ``--timeout *SECONDS*``
Exit after timeout period (in seconds), provided there are no client
connections.
``-v``, ``--verbose``
Enable output of verbose messages.
``--version``
Display version information then exit.
SIGNALS
=======
On receipt of ``SIGHUP`` ``virtvboxd`` will reload its configuration.
FILES
=====
When run as *root*
------------------
* ``@SYSCONFDIR@/libvirt/virtvboxd.conf``
The default configuration file used by ``virtvboxd``, unless overridden on the
command line using the ``-f`` | ``--config`` option.
* ``@RUNSTATEDIR@/libvirt/virtvboxd-sock``
* ``@RUNSTATEDIR@/libvirt/virtvboxd-sock-ro``
* ``@RUNSTATEDIR@/libvirt/virtvboxd-admin-sock``
The sockets ``virtvboxd`` will use.
The TLS **Server** private key ``virtvboxd`` will use.
* ``@RUNSTATEDIR@/virtvboxd.pid``
The PID file to use, unless overridden by the ``-p`` | ``--pid-file`` option.
When run as *non-root*
----------------------
* ``$XDG_CONFIG_HOME/libvirt/virtvboxd.conf``
The default configuration file used by ``virtvboxd``, unless overridden on the
command line using the ``-f``|``--config`` option.
* ``$XDG_RUNTIME_DIR/libvirt/virtvboxd-sock``
* ``$XDG_RUNTIME_DIR/libvirt/virtvboxd-admin-sock``
The sockets ``virtvboxd`` will use.
* ``$XDG_RUNTIME_DIR/libvirt/virtvboxd.pid``
The PID file to use, unless overridden by the ``-p``|``--pid-file`` option.
If ``$XDG_CONFIG_HOME`` is not set in your environment, ``virtvboxd`` will use
``$HOME/.config``
If ``$XDG_RUNTIME_DIR`` is not set in your environment, ``virtvboxd`` will use
``$HOME/.cache``
EXAMPLES
========
To retrieve the version of ``virtvboxd``:
::
# virtvboxd --version
virtvboxd (libvirt) @VERSION@
To start ``virtvboxd``, instructing it to daemonize and create a PID file:
::
# virtvboxd -d
# ls -la @RUNSTATEDIR@/virtvboxd.pid
-rw-r--r-- 1 root root 6 Jul 9 02:40 @RUNSTATEDIR@/virtvboxd.pid
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.
AUTHORS
=======
Please refer to the AUTHORS file distributed with libvirt.
COPYRIGHT
=========
Copyright (C) 2006-2020 Red Hat, Inc., and the authors listed in the
libvirt AUTHORS file.
LICENSE
=======
``virtvboxd`` is distributed under the terms of the GNU LGPL v2.1+.
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), libvirtd(8),
`https://www.libvirt.org/daemons.html <https://www.libvirt.org/daemons.html>`_,
`https://www.libvirt.org/drvvbox.html <https://www.libvirt.org/drvvbox.html>`_