External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-11-05 04:41:20 +00:00
Code Issues Packages Projects Releases Wiki Activity
6e51642bd2
libvirt/daemon/libvirtd.pod

207 lines
4.8 KiB
Plaintext
Raw Normal View History

libvirtd: add man page for libvirtd With gracious thanks to Chris Lalancette for helping knock the description section into shape. This addresses BZ #595350 https://bugzilla.redhat.com/show_bug.cgi?id=595350
2010-07-09 09:21:39 +00:00
=head1 NAME
libvirtd - libvirtd management daemon
=head1 SYNOPSIS
man: Fix SYNOPSIS section Format the text properly.
2016-04-13 17:57:37 +00:00
B<libvirtd> [I<OPTION>]...
libvirtd: add man page for libvirtd With gracious thanks to Chris Lalancette for helping knock the description section into shape. This addresses BZ #595350 https://bugzilla.redhat.com/show_bug.cgi?id=595350
2010-07-09 09:21:39 +00:00
=head1 DESCRIPTION
The B<libvirtd> program is the server side daemon component of the libvirt
virtualization management system.
This daemon runs on host servers and performs required management tasks for
virtualized guests. This includes activities such as starting, stopping
and migrating guests between host servers, configuring and manipulating
networking, and managing storage for use by guests.
The libvirt client libraries and utilities connect to this daemon to issue
tasks and collect information about the configuration and resources of the host
system and guests.
By default, the libvirtd daemon listens for requests on a local Unix domain
socket. Using the B<-l>|B<--listen> command line option, the libvirtd daemon
can be instructed to additionally listen on a TCP/IP socket. The TCP/IP socket
to use is defined in the libvirtd configuration file.
Restarting libvirtd does not impact running guests. Guests continue to operate
and will be picked up automatically if their XML configuration has been
defined. Any guests whose XML configuration has not been defined will be lost
from the configuration.
=head1 OPTIONS
=over
Properly handle -h / -V for --help/--version aliases in virtlockd/libvirtd The virtlockd/libvirtd daemons had listed '?' as the short option for --help. getopt_long uses '?' for any unknown option. We want to be able to distinguish unknown options (which use EXIT_FAILURE) from correct usage of help (which should use EXIT_SUCCESS). Thus we should use 'h' as a short option for --help. Also add this to the man page docs The virtlockd/libvirtd daemons did not list any short option for the --version arg. Add -V as a valid short option, since -v is already used for --verbose. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2013-08-13 11:14:15 +00:00
=item B<-h, --help>
Display command line help usage then exit.
libvirtd: add man page for libvirtd With gracious thanks to Chris Lalancette for helping knock the description section into shape. This addresses BZ #595350 https://bugzilla.redhat.com/show_bug.cgi?id=595350
2010-07-09 09:21:39 +00:00
=item B<-d, --daemon>
Run as a daemon & write PID file.
=item B<-f, --config> I<FILE>
Use this configuration file, overriding the default value.
=item B<-l, --listen>
Listen for TCP/IP connections.
=item B<-p, --pid-file> I<FILE>
Use this name for the PID file, overriding the default value.
=item B<-t, --timeout> I<SECONDS>
doc: add more description on libvirtd option timeout
2012-07-25 16:22:53 +00:00
Exit after timeout period (in seconds) elapse with no client connections
or registered resources. Be aware that resources such as autostart
networks will result in never reaching the timeout, even when there are
no client connections.
libvirtd: add man page for libvirtd With gracious thanks to Chris Lalancette for helping knock the description section into shape. This addresses BZ #595350 https://bugzilla.redhat.com/show_bug.cgi?id=595350
2010-07-09 09:21:39 +00:00
=item B<-v, --verbose>
Enable output of verbose messages.
=item B< --version>
Display version information then exit.
=back
=head1 SIGNALS
On receipt of B<SIGHUP> libvirtd will reload its configuration.
=head1 FILES
Update paths in man page to reflect libvirtd code Updated the paths in the man page to reflect what the code in libvirtd does. In addition broke out the FILES section into two subsections for files used when run as root and files used when run as non-root. Provided information about the defaults that libvirtd uses when running as non-root and when XDG_CONFIG_HOME and XDG_RUNTIME_DIR are not set in the environment.
2012-08-13 04:44:49 +00:00
=head2 When run as B<root>.
libvirtd: add man page for libvirtd With gracious thanks to Chris Lalancette for helping knock the description section into shape. This addresses BZ #595350 https://bugzilla.redhat.com/show_bug.cgi?id=595350
2010-07-09 09:21:39 +00:00
=over
man: Fix documentation errors about the paths of the config files The default conf files, for example libvirtd.conf, virtlockd.conf, and virtlogd.conf, should be located under the directory "/etc/libvirt" when root as root, rather than "/etc". When run as non-root, the configuration files should be located under "$XDG_CONFIG_HOME/libvirt/", rather than "XDG_CONFIG_HOME". Signed-off-by: Lily Zhu <lizhu@redhat.com> Signed-off-by: Erik Skultety <eskultet@redhat.com>
2017-06-28 06:00:48 +00:00
=item F<SYSCONFDIR/libvirt/libvirtd.conf>
libvirtd: add man page for libvirtd With gracious thanks to Chris Lalancette for helping knock the description section into shape. This addresses BZ #595350 https://bugzilla.redhat.com/show_bug.cgi?id=595350
2010-07-09 09:21:39 +00:00
The default configuration file used by libvirtd, unless overridden on the
command line using the B<-f>|B<--config> option.
Fix man page file paths to real paths Currently the man page has paths that start with @sysconfdir@, @localstatedir@ and @remote_pid_file@. The sed command attempts to replace these during the build but unfortunately pod2man gets to the files first and escapes the @ character resulting in the sed not working. This removes the @ character and makes the paths correct.
2012-08-13 04:44:47 +00:00
=item F<LOCALSTATEDIR/run/libvirt/libvirt-sock>
libvirtd: add man page for libvirtd With gracious thanks to Chris Lalancette for helping knock the description section into shape. This addresses BZ #595350 https://bugzilla.redhat.com/show_bug.cgi?id=595350
2010-07-09 09:21:39 +00:00
Fix man page file paths to real paths Currently the man page has paths that start with @sysconfdir@, @localstatedir@ and @remote_pid_file@. The sed command attempts to replace these during the build but unfortunately pod2man gets to the files first and escapes the @ character resulting in the sed not working. This removes the @ character and makes the paths correct.
2012-08-13 04:44:47 +00:00
=item F<LOCALSTATEDIR/run/libvirt/libvirt-sock-ro>
libvirtd: add man page for libvirtd With gracious thanks to Chris Lalancette for helping knock the description section into shape. This addresses BZ #595350 https://bugzilla.redhat.com/show_bug.cgi?id=595350
2010-07-09 09:21:39 +00:00
Update paths in man page to reflect libvirtd code Updated the paths in the man page to reflect what the code in libvirtd does. In addition broke out the FILES section into two subsections for files used when run as root and files used when run as non-root. Provided information about the defaults that libvirtd uses when running as non-root and when XDG_CONFIG_HOME and XDG_RUNTIME_DIR are not set in the environment.
2012-08-13 04:44:49 +00:00
The sockets libvirtd will use.
libvirtd: add man page for libvirtd With gracious thanks to Chris Lalancette for helping knock the description section into shape. This addresses BZ #595350 https://bugzilla.redhat.com/show_bug.cgi?id=595350
2010-07-09 09:21:39 +00:00
Fix man page file paths to real paths Currently the man page has paths that start with @sysconfdir@, @localstatedir@ and @remote_pid_file@. The sed command attempts to replace these during the build but unfortunately pod2man gets to the files first and escapes the @ character resulting in the sed not working. This removes the @ character and makes the paths correct.
2012-08-13 04:44:47 +00:00
=item F<SYSCONFDIR/pki/CA/cacert.pem>
libvirtd: add man page for libvirtd With gracious thanks to Chris Lalancette for helping knock the description section into shape. This addresses BZ #595350 https://bugzilla.redhat.com/show_bug.cgi?id=595350
2010-07-09 09:21:39 +00:00
The TLS B<Certificate Authority> certificate libvirtd will use.
Fix man page file paths to real paths Currently the man page has paths that start with @sysconfdir@, @localstatedir@ and @remote_pid_file@. The sed command attempts to replace these during the build but unfortunately pod2man gets to the files first and escapes the @ character resulting in the sed not working. This removes the @ character and makes the paths correct.
2012-08-13 04:44:47 +00:00
=item F<SYSCONFDIR/pki/libvirt/servercert.pem>
libvirtd: add man page for libvirtd With gracious thanks to Chris Lalancette for helping knock the description section into shape. This addresses BZ #595350 https://bugzilla.redhat.com/show_bug.cgi?id=595350
2010-07-09 09:21:39 +00:00
The TLS B<Server> certificate libvirtd will use.
Fix man page file paths to real paths Currently the man page has paths that start with @sysconfdir@, @localstatedir@ and @remote_pid_file@. The sed command attempts to replace these during the build but unfortunately pod2man gets to the files first and escapes the @ character resulting in the sed not working. This removes the @ character and makes the paths correct.
2012-08-13 04:44:47 +00:00
=item F<SYSCONFDIR/pki/libvirt/private/serverkey.pem>
libvirtd: add man page for libvirtd With gracious thanks to Chris Lalancette for helping knock the description section into shape. This addresses BZ #595350 https://bugzilla.redhat.com/show_bug.cgi?id=595350
2010-07-09 09:21:39 +00:00
The TLS B<Server> private key libvirtd will use.
Replace unset REMOTE_PID_FILE with proper value REMOTE_PID_FILE is no longer used in the source or the build process but the man page still used it resulting in no file name being displayed. The same value that the libvirtd daemon code uses is now used in the man page.
2012-08-13 04:44:48 +00:00
=item F<LOCALSTATEDIR/run/libvirtd.pid>
libvirtd: add man page for libvirtd With gracious thanks to Chris Lalancette for helping knock the description section into shape. This addresses BZ #595350 https://bugzilla.redhat.com/show_bug.cgi?id=595350
2010-07-09 09:21:39 +00:00
The PID file to use, unless overridden by the B<-p>|B<--pid-file> option.
=back
Update paths in man page to reflect libvirtd code Updated the paths in the man page to reflect what the code in libvirtd does. In addition broke out the FILES section into two subsections for files used when run as root and files used when run as non-root. Provided information about the defaults that libvirtd uses when running as non-root and when XDG_CONFIG_HOME and XDG_RUNTIME_DIR are not set in the environment.
2012-08-13 04:44:49 +00:00
=head2 When run as B<non-root>.
=over
man: Fix documentation errors about the paths of the config files The default conf files, for example libvirtd.conf, virtlockd.conf, and virtlogd.conf, should be located under the directory "/etc/libvirt" when root as root, rather than "/etc". When run as non-root, the configuration files should be located under "$XDG_CONFIG_HOME/libvirt/", rather than "XDG_CONFIG_HOME". Signed-off-by: Lily Zhu <lizhu@redhat.com> Signed-off-by: Erik Skultety <eskultet@redhat.com>
2017-06-28 06:00:48 +00:00
=item F<$XDG_CONFIG_HOME/libvirt/libvirtd.conf>
Update paths in man page to reflect libvirtd code Updated the paths in the man page to reflect what the code in libvirtd does. In addition broke out the FILES section into two subsections for files used when run as root and files used when run as non-root. Provided information about the defaults that libvirtd uses when running as non-root and when XDG_CONFIG_HOME and XDG_RUNTIME_DIR are not set in the environment.
2012-08-13 04:44:49 +00:00
The default configuration file used by libvirtd, unless overridden on the
command line using the B<-f>|B<--config> option.
=item F<$XDG_RUNTIME_DIR/libvirt/libvirt-sock>
The socket libvirtd will use.
=item F<$HOME/.pki/libvirt/cacert.pem>
The TLS B<Certificate Authority> certificate libvirtd will use.
=item F<$HOME/.pki/libvirt/servercert.pem>
The TLS B<Server> certificate libvirtd will use.
=item F<$HOME/.pki/libvirt/serverkey.pem>
The TLS B<Server> private key libvirtd will use.
=item F<$XDG_RUNTIME_DIR/libvirt/libvirtd.pid>
The PID file to use, unless overridden by the B<-p>|B<--pid-file> option.
=item If $XDG_CONFIG_HOME is not set in your environment, libvirtd will use F<$HOME/.config>
=item If $XDG_RUNTIME_DIR is not set in your environment, libvirtd will use F<$HOME/.cache>
=back
libvirtd: add man page for libvirtd With gracious thanks to Chris Lalancette for helping knock the description section into shape. This addresses BZ #595350 https://bugzilla.redhat.com/show_bug.cgi?id=595350
2010-07-09 09:21:39 +00:00
=head1 EXAMPLES
To retrieve the version of libvirtd:
# libvirtd --version
libvirtd (libvirt) 0.8.2
#
To start libvirtd, instructing it to daemonize and create a PID file:
# libvirtd -d
Replace unset REMOTE_PID_FILE with proper value REMOTE_PID_FILE is no longer used in the source or the build process but the man page still used it resulting in no file name being displayed. The same value that the libvirtd daemon code uses is now used in the man page.
2012-08-13 04:44:48 +00:00
# ls -la LOCALSTATEDIR/run/libvirtd.pid
-rw-r--r-- 1 root root 6 Jul 9 02:40 LOCALSTATEDIR/run/libvirtd.pid
libvirtd: add man page for libvirtd With gracious thanks to Chris Lalancette for helping knock the description section into shape. This addresses BZ #595350 https://bugzilla.redhat.com/show_bug.cgi?id=595350
2010-07-09 09:21:39 +00:00
#
=head1 BUGS
Please report all bugs you discover. This should be done via either:
=over
=item a) the mailing list
L<http://libvirt.org/contact.html>
=item or,
B<>
=item b) the bug tracker
L<http://libvirt.org/bugs.html>
=item Alternatively, you may report bugs to your software distributor / vendor.
=back
=head1 AUTHORS
man pages: update authors and copyright notice for libvirtd and virsh This patch removes the individual author names from the libvirtd and virsh man pages, instead referring to the main AUTHORS file distributed with libvirt. This approach is needed, as we can't guarantee unicode support across all versions of pod2man used with libvirt. Additionally, this patch includes the libvirtd man page in the spec file used with "make rpm". Without this patch "make rpm" is broken.
2010-07-12 19:33:35 +00:00
Please refer to the AUTHORS file distributed with libvirt.
libvirtd: add man page for libvirtd With gracious thanks to Chris Lalancette for helping knock the description section into shape. This addresses BZ #595350 https://bugzilla.redhat.com/show_bug.cgi?id=595350
2010-07-09 09:21:39 +00:00
=head1 COPYRIGHT
Fixup manpage names and copyright dates The copyright dates in the manpages haven't been updated in awhile. Also, when pod2man converts a pod file into a manpage, it will only remove the extension from the filename if it is ".pod". Some of the libvirt pod files are named *.pod.in, and that filename is placed unchanged into the manpage. This patch uses pod2man's --name option to fix that. Believe it or not, there's even a BZ for this: https://bugzilla.redhat.com/show_bug.cgi?id=819364
2012-07-24 17:41:03 +00:00
Copyright (C) 2006-2012 Red Hat, Inc., and the authors listed in the
man pages: update authors and copyright notice for libvirtd and virsh This patch removes the individual author names from the libvirtd and virsh man pages, instead referring to the main AUTHORS file distributed with libvirt. This approach is needed, as we can't guarantee unicode support across all versions of pod2man used with libvirt. Additionally, this patch includes the libvirtd man page in the spec file used with "make rpm". Without this patch "make rpm" is broken.
2010-07-12 19:33:35 +00:00
libvirt AUTHORS file.
libvirtd: add man page for libvirtd With gracious thanks to Chris Lalancette for helping knock the description section into shape. This addresses BZ #595350 https://bugzilla.redhat.com/show_bug.cgi?id=595350
2010-07-09 09:21:39 +00:00
=head1 LICENSE
libvirtd 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
=head1 SEE ALSO
L<virsh(1)>, L<virt-install(1)>, L<virt-xml-validate(1)>, L<virt-top(1)>,
docs: removed outdated reference to virt-mem The virt-mem program is no longer shipped, but was still being referenced at the bottom of the virsh and libvirtd man pages. This patch removes it from those man pages, addressing BZ# 639603: https://bugzilla.redhat.com/show_bug.cgi?id=639603
2010-11-22 11:55:35 +00:00
L<virt-df(1)>, L<http://www.libvirt.org/>
libvirtd: add man page for libvirtd With gracious thanks to Chris Lalancette for helping knock the description section into shape. This addresses BZ #595350 https://bugzilla.redhat.com/show_bug.cgi?id=595350
2010-07-09 09:21:39 +00:00
=cut
Reference in New Issue Copy Permalink