[libvirt] [PATCH 06/17] docs: convert libvirtd man page from pod to rst

This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Signed-off-by: Daniel P. Berrangé <berrange(a)redhat.com&gt; --- docs/Makefile.am | 9 ++ docs/manpages/index.rst | 5 + docs/manpages/libvirtd.rst | 259 +++++++++++++++++++++++++++++++++++++ src/remote/Makefile.inc.am | 15 --- src/remote/libvirtd.pod | 235 --------------------------------- 5 files changed, 273 insertions(+), 250 deletions(-) create mode 100644 docs/manpages/libvirtd.rst delete mode 100644 src/remote/libvirtd.pod diff --git a/docs/Makefile.am b/docs/Makefile.am index 34fea87805..8205f28788 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -211,6 +211,15 @@ manpages_rst += \ $(manpages7_rst) \ $(manpages8_rst) \ $(NULL) +if WITH_LIBVIRTD +manpages8_rst += \ + manpages/libvirtd.rst \ + $(NULL) +else ! WITH_LIBVIRTD +manpages_rst += \ + manpages/libvirtd.rst \ + $(NULL) +endif ! WITH_LIBVIRTD manpages_rst_html_in = \ $(manpages_rst:%.rst=%.html.in) manpages_html = \ diff --git a/docs/manpages/index.rst b/docs/manpages/index.rst index 11c72135e8..4467d88ba1 100644 --- a/docs/manpages/index.rst +++ b/docs/manpages/index.rst @@ -1,3 +1,8 @@ ==================== Libvirt Manual Pages ==================== + +Daemons +======= + +* `libvirtd(8) <libvirtd.html>`__ - libvirt management daemon diff --git a/docs/manpages/libvirtd.rst b/docs/manpages/libvirtd.rst new file mode 100644 index 0000000000..b7489a57fc --- /dev/null +++ b/docs/manpages/libvirtd.rst @@ -0,0 +1,259 @@ +======== +libvirtd +======== + +------------------------- +libvirt management daemon +------------------------- + +:Manual section: 8 +:Manual group: Virtualization Support + +.. contents:: + +SYNOPSIS +======== + +``libvirtd`` [*OPTION*]... + + +DESCRIPTION +=========== + +The ``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 ``-l`` | ``--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. + + +SYSTEM SOCKET ACTIVATION +======================== + +The ``libvirtd`` daemon is capable of starting in two modes. + +In the traditional mode, it will create and listen on UNIX sockets itself. +If the ``--listen`` parameter is given, it will also listen on TCP/IP socket(s), +according to the ``listen_tcp`` and ``listen_tls`` options in +``/etc/libvirt/libvirtd.conf`` + +In socket activation mode, it will rely on systemd to create and listen +on the UNIX, and optionally TCP/IP, sockets and pass them as pre-opened +file descriptors. In this mode, it is not permitted to pass the ``--listen`` +parameter, and most of the socket related config options in +``/etc/libvirt/libvirtd.conf`` will no longer have any effect. To enable +TCP or TLS sockets use either + +:: + + $ systemctl start libvirtd-tls.socket + +Or + +:: + + $ systemctl start libvirtd-tcp.socket + +Socket activation mode is generally the default when running on a host +OS that uses systemd. To revert to the traditional mode, all the socket +unit files must be masked: + +:: + + $ systemctl mask libvirtd.socket libvirtd-ro.socket \ + libvirtd-admin.socket libvirtd-tls.socket libvirtd-tcp.socket + + +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. + +``-l``, ``--listen`` + +Listen for TCP/IP connections. This should not be set if using systemd +socket activation. Instead activate the libvirtd-tls.socket or +libvirtd-tcp.socket unit files. + +``-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 neither any client +connections nor any running domains. + +``-v``, ``--verbose`` + +Enable output of verbose messages. + +``--version`` + +Display version information then exit. + + +SIGNALS +======= + +On receipt of ``SIGHUP`` libvirtd will reload its configuration. + + +FILES +===== + +When run as *root* +------------------ + +* ``SYSCONFDIR/libvirt/libvirtd.conf`` + +The default configuration file used by libvirtd, unless overridden on the +command line using the ``-f`` | ``--config`` option. + +* ``RUNSTATEDIR/libvirt/libvirt-sock`` +* ``RUNSTATEDIR/libvirt/libvirt-sock-ro`` + +The sockets libvirtd will use. + +* ``SYSCONFDIR/pki/CA/cacert.pem`` + +The TLS **Certificate Authority** certificate libvirtd will use. + +* ``SYSCONFDIR/pki/libvirt/servercert.pem`` + +The TLS **Server** certificate libvirtd will use. + +* ``SYSCONFDIR/pki/libvirt/private/serverkey.pem`` + +The TLS **Server** private key libvirtd will use. + +* ``RUNSTATEDIR/libvirtd.pid`` + +The PID file to use, unless overridden by the ``-p`` | ``--pid-file`` option. + + +When run as *non-root* +---------------------- + +* ``$XDG_CONFIG_HOME/libvirt/libvirtd.conf`` + +The default configuration file used by libvirtd, unless overridden on the +command line using the ``-f``|``--config`` option. + +* ``$XDG_RUNTIME_DIR/libvirt/libvirt-sock`` + +The socket libvirtd will use. + +* ``$HOME/.pki/libvirt/cacert.pem`` + +The TLS **Certificate Authority** certificate libvirtd will use. + +* ``$HOME/.pki/libvirt/servercert.pem`` + +The TLS **Server** certificate libvirtd will use. + +* ``$HOME/.pki/libvirt/serverkey.pem`` + +The TLS **Server** private key libvirtd will use. + +* ``$XDG_RUNTIME_DIR/libvirt/libvirtd.pid`` + +The PID file to use, unless overridden by the ``-p``|``--pid-file`` option. + + +If ``$XDG_CONFIG_HOME`` is not set in your environment, libvirtd will use +``$HOME/.config`` + +If ``$XDG_RUNTIME_DIR`` is not set in your environment, libvirtd will use +``$HOME/.cache`` + + +EXAMPLES +======== + +To retrieve the version of libvirtd: + +.. code-block:: shell + + # libvirtd --version + libvirtd (libvirt) 0.8.2 + + +To start libvirtd, instructing it to daemonize and create a PID file: + +.. code-block:: shell + + # libvirtd -d + # ls -la RUNSTATEDIR/libvirtd.pid + -rw-r--r-- 1 root root 6 Jul 9 02:40 RUNSTATEDIR/libvirtd.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-2012 Red Hat, Inc., and the authors listed in the +libvirt AUTHORS file. + + +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 + + +SEE ALSO +======== + +virsh(1), virt-install(1), virt-xml-validate(1), virt-top(1), +virt-df(1), `https://www.libvirt.org/ <https://www.libvirt.org/>`_ diff --git a/src/remote/Makefile.inc.am b/src/remote/Makefile.inc.am index 8103cfb96a..f648aa4ee4 100644 --- a/src/remote/Makefile.inc.am +++ b/src/remote/Makefile.inc.am @@ -91,9 +91,6 @@ LOGROTATE_FILES_IN += \ SYSCONF_FILES += remote/libvirtd.sysconf -PODFILES += remote/libvirtd.pod -MANINFILES += libvirtd.8.in - LIBVIRTD_SOCKET_UNIT_FILES_IN = \ remote/libvirtd.socket.in \ remote/libvirtd-ro.socket.in \ @@ -227,8 +224,6 @@ CLEANFILES += \ remote/virtproxyd.aug \ $(NULL) -man8_MANS += libvirtd.8 - libvirtd_SOURCES = $(REMOTE_DAEMON_SOURCES) nodist_libvirtd_SOURCES = $(REMOTE_DAEMON_GENERATED) @@ -462,13 +457,3 @@ remote/qemu_daemon_dispatch_stubs.h: $(srcdir)/rpc/gendispatch.pl \ $(AM_V_GEN)$(PERL) -w $(top_srcdir)/src/rpc/gendispatch.pl \ --mode=server qemu QEMU $(QEMU_PROTOCOL) \ - -libvirtd.8.in: remote/libvirtd.pod - $(AM_V_GEN)$(POD2MAN) --section=8 $< $@-t1 && \ - if grep 'POD ERROR' $@-t1; then rm $@-t1; exit 1; fi && \ - sed \ - -e 's|SYSCONFDIR|\@sysconfdir\@|g' \ - -e 's|RUNSTATEDIR|\@runstatedir\@|g' \ - < $@-t1 > $@-t2 && \ - rm -f $@-t1 && \ - mv $@-t2 $@ diff --git a/src/remote/libvirtd.pod b/src/remote/libvirtd.pod deleted file mode 100644 index 24def17dc4..0000000000 --- a/src/remote/libvirtd.pod +++ /dev/null @@ -1,235 +0,0 @@ -=head1 NAME - -libvirtd - libvirtd management daemon - -=head1 SYNOPSIS - -B<libvirtd> [I<OPTION>]... - -=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 SYSTEM SOCKET ACTIVATION - -The B<libvirtd> daemon is capable of starting in two modes. - -In the traditional mode, it will create and listen on UNIX sockets itself. -If the B<--listen> parameter is given, it will also listen on TCP/IP socket(s), -according to the B<listen_tcp> and B<listen_tls> options in -B</etc/libvirt/libvirtd.conf> - -In socket activation mode, it will rely on systemd to create and listen -on the UNIX, and optionally TCP/IP, sockets and pass them as pre-opened -file descriptors. In this mode, it is not permitted to pass the B<--listen> -parameter, and most of the socket related config options in -B</etc/libvirt/libvirtd.conf> will no longer have any effect. To enable -TCP or TLS sockets use either - -B<$ systemctl start libvirtd-tls.socket> - -Or - -B<$ systemctl start libvirtd-tcp.socket> - -Socket activation mode is generally the default when running on a host -OS that uses systemd. To revert to the traditional mode, all the socket -unit files must be masked: - -B<$ systemctl mask libvirtd.socket libvirtd-ro.socket \ - libvirtd-admin.socket libvirtd-tls.socket libvirtd-tcp.socket> - -=head1 OPTIONS - -=over - -=item B<-h, --help> - -Display command line help usage then exit. - -=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. This should not be set if using systemd -socket activation. Instead activate the libvirtd-tls.socket or -libvirtd-tcp.socket unit files. - -=item B<-p, --pid-file> I<FILE> - -Use this name for the PID file, overriding the default value. - -=item B<-t, --timeout> I<SECONDS> - -Exit after timeout period (in seconds), provided there are neither any client -connections nor any running domains. - -=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 - -=head2 When run as B<root>. - -=over - -=item F<SYSCONFDIR/libvirt/libvirtd.conf> - -The default configuration file used by libvirtd, unless overridden on the -command line using the B<-f>|B<--config> option. - -=item F<RUNSTATEDIR/libvirt/libvirt-sock> - -=item F<RUNSTATEDIR/libvirt/libvirt-sock-ro> - -The sockets libvirtd will use. - -=item F<SYSCONFDIR/pki/CA/cacert.pem> - -The TLS B<Certificate Authority> certificate libvirtd will use. - -=item F<SYSCONFDIR/pki/libvirt/servercert.pem> - -The TLS B<Server> certificate libvirtd will use. - -=item F<SYSCONFDIR/pki/libvirt/private/serverkey.pem> - -The TLS B<Server> private key libvirtd will use. - -=item F<RUNSTATEDIR/libvirtd.pid> - -The PID file to use, unless overridden by the B<-p>|B<--pid-file> option. - -=back - -=head2 When run as B<non-root>. - -=over - -=item F<$XDG_CONFIG_HOME/libvirt/libvirtd.conf> - -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 - -=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 - # ls -la RUNSTATEDIR/libvirtd.pid - -rw-r--r-- 1 root root 6 Jul 9 02:40 RUNSTATEDIR/libvirtd.pid - # - -=head1 BUGS - -Please report all bugs you discover. This should be done via either: - -=over - -=item a) the mailing list - -L<https://libvirt.org/contact.html> - -=item or, - -B<> - -=item b) the bug tracker - -L<https://libvirt.org/bugs.html> - -=item Alternatively, you may report bugs to your software distributor / vendor. - -=back - -=head1 AUTHORS - -Please refer to the AUTHORS file distributed with libvirt. - -=head1 COPYRIGHT - -Copyright (C) 2006-2012 Red Hat, Inc., and the authors listed in the -libvirt AUTHORS file. - -=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)>, -L<virt-df(1)>, L<https://www.libvirt.org/> - -=cut -- 2.23.0