From nobody Tue Nov 26 11:47:52 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 205.139.110.120 as permitted sender) client-ip=205.139.110.120; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-1.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 205.139.110.120 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1575643926; cv=none; d=zohomail.com; s=zohoarc; b=ZgrrWnvWAGW4B81smnTrwbJDKM4pouJC47YyxiMD4FR4V8IbhXe0f6yF8qMU29jCYXY6hZp+t+tbe2SYMTza3jP/MAbD+naQ3axnB/78naWQeZy1mm4lujZLsi9TGefguOCZCYY8HQcQjzmOq2KUeqXBqM1VlfMk84cSaMMkDgI= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1575643926; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=YR03o5pYjcOQrNU3kxMnJx8i3LDSvz46xk/9fSh/tEE=; b=cSyALZNspbmUc7I2I6N9KTaNt6xziSG7VrOoKN0aKc9PEh2o/aQbXlFQbFz5TNgsr0SSPrBdjA0OUr9RD2kI4u8xtC/Oj4Pv8pWaGBU+/OVSc2XVCjkvs689FzadVa3aMJdB+eRTVy6r7g4wQ/e2kXKiil1pcpnK+mgIz7XovTw= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 205.139.110.120 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-1.mimecast.com (us-smtp-delivery-1.mimecast.com [205.139.110.120]) by mx.zohomail.com with SMTPS id 157564392627736.560657354687805; Fri, 6 Dec 2019 06:52:06 -0800 (PST) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-295-HJyaAaptOFOAD7rwA20E-A-1; Fri, 06 Dec 2019 09:51:21 -0500 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 1F8E618AAFA5; Fri, 6 Dec 2019 14:51:15 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20]) by smtp.corp.redhat.com (Postfix) with ESMTPS id E921D5D6C3; Fri, 6 Dec 2019 14:51:14 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id A1B7D1803C41; Fri, 6 Dec 2019 14:51:14 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id xB6EpCQK017017 for ; Fri, 6 Dec 2019 09:51:12 -0500 Received: by smtp.corp.redhat.com (Postfix) id 8620A5DA32; Fri, 6 Dec 2019 14:51:12 +0000 (UTC) Received: from localhost.localdomain.com (ovpn-112-49.ams2.redhat.com [10.36.112.49]) by smtp.corp.redhat.com (Postfix) with ESMTP id 82D3D5D9E2; Fri, 6 Dec 2019 14:51:09 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1575643925; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=YR03o5pYjcOQrNU3kxMnJx8i3LDSvz46xk/9fSh/tEE=; b=fYEbaq1sQXNSb+PbouQrazZWbvqm8qS+bhvgso4r9s0sBsHv90/K41caxHaU+470BgmKTs 5vETaWvRUv6+VuqaLZIn1NvmqkPzckcyUHbEal+0LdSNpye087xDjnYY0kDzcgHvzMdh51 xCwMQrJMp9hl+uF+UxXd1fgnXVNNj4E= From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: libvir-list@redhat.com Date: Fri, 6 Dec 2019 14:50:31 +0000 Message-Id: <20191206145042.3777845-7-berrange@redhat.com> In-Reply-To: <20191206145042.3777845-1-berrange@redhat.com> References: <20191206145042.3777845-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 X-loop: libvir-list@redhat.com Subject: [libvirt] [PATCH 06/17] docs: convert libvirtd man page from pod to rst X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 X-MC-Unique: HJyaAaptOFOAD7rwA20E-A-1 X-Mimecast-Spam-Score: 0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) 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=C3=A9 --- 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 +=3D \ $(manpages7_rst) \ $(manpages8_rst) \ $(NULL) +if WITH_LIBVIRTD +manpages8_rst +=3D \ + manpages/libvirtd.rst \ + $(NULL) +else ! WITH_LIBVIRTD +manpages_rst +=3D \ + manpages/libvirtd.rst \ + $(NULL) +endif ! WITH_LIBVIRTD manpages_rst_html_in =3D \ $(manpages_rst:%.rst=3D%.html.in) manpages_html =3D \ 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 @@ =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D Libvirt Manual Pages =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Daemons +=3D=3D=3D=3D=3D=3D=3D + +* `libvirtd(8) `__ - 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 @@ +=3D=3D=3D=3D=3D=3D=3D=3D +libvirtd +=3D=3D=3D=3D=3D=3D=3D=3D + +------------------------- +libvirt management daemon +------------------------- + +:Manual section: 8 +:Manual group: Virtualization Support + +.. contents:: + +SYNOPSIS +=3D=3D=3D=3D=3D=3D=3D=3D + +``libvirtd`` [*OPTION*]... + + +DESCRIPTION +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +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 s= ocket +to use is defined in the libvirtd configuration file. + +Restarting libvirtd does not impact running guests. Guests continue to op= erate +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 +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +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 sock= et(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 +=3D=3D=3D=3D=3D=3D=3D + +``-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 cli= ent +connections nor any running domains. + +``-v``, ``--verbose`` + +Enable output of verbose messages. + +``--version`` + +Display version information then exit. + + +SIGNALS +=3D=3D=3D=3D=3D=3D=3D + +On receipt of ``SIGHUP`` libvirtd will reload its configuration. + + +FILES +=3D=3D=3D=3D=3D + +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`` opti= on. + + +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 +=3D=3D=3D=3D=3D=3D=3D=3D + +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 +=3D=3D=3D=3D + +Please report all bugs you discover. This should be done via either: + +#. the mailing list + + `https://libvirt.org/contact.html `_ + +#. the bug tracker + + `https://libvirt.org/bugs.html `_ + +Alternatively, you may report bugs to your software distributor / vendor. + + +AUTHORS +=3D=3D=3D=3D=3D=3D=3D + +Please refer to the AUTHORS file distributed with libvirt. + + +COPYRIGHT +=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Copyright (C) 2006-2012 Red Hat, Inc., and the authors listed in the +libvirt AUTHORS file. + + +LICENSE +=3D=3D=3D=3D=3D=3D=3D + +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 +=3D=3D=3D=3D=3D=3D=3D=3D + +virsh(1), virt-install(1), virt-xml-validate(1), virt-top(1), +virt-df(1), `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 +=3D \ =20 SYSCONF_FILES +=3D remote/libvirtd.sysconf =20 -PODFILES +=3D remote/libvirtd.pod -MANINFILES +=3D libvirtd.8.in - LIBVIRTD_SOCKET_UNIT_FILES_IN =3D \ remote/libvirtd.socket.in \ remote/libvirtd-ro.socket.in \ @@ -227,8 +224,6 @@ CLEANFILES +=3D \ remote/virtproxyd.aug \ $(NULL) =20 -man8_MANS +=3D libvirtd.8 - libvirtd_SOURCES =3D $(REMOTE_DAEMON_SOURCES) =20 nodist_libvirtd_SOURCES =3D $(REMOTE_DAEMON_GENERATED) @@ -462,13 +457,3 @@ remote/qemu_daemon_dispatch_stubs.h: $(srcdir)/rpc/gen= dispatch.pl \ $(AM_V_GEN)$(PERL) -w $(top_srcdir)/src/rpc/gendispatch.pl \ --mode=3Dserver qemu QEMU $(QEMU_PROTOCOL) \ > remote/qemu_daemon_dispatch_stubs.h - -libvirtd.8.in: remote/libvirtd.pod - $(AM_V_GEN)$(POD2MAN) --section=3D8 $< $@-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 @@ -=3Dhead1 NAME - -libvirtd - libvirtd management daemon - -=3Dhead1 SYNOPSIS - -B [I