Re: [libvirt PATCH v2 08/16] docs: add manpage for virtnetworkd

2021-01-06 Thread Jiri Denemark
On Tue, Jan 05, 2021 at 17:25:46 +, Daniel P. Berrangé wrote:
> This is an adaptation of the libvirtd manpage.
> 
> Signed-off-by: Daniel P. Berrangé 
> ---
>  docs/manpages/index.rst|   1 +
>  docs/manpages/meson.build  |   1 +
>  docs/manpages/virtnetworkd.rst | 215 +
>  3 files changed, 217 insertions(+)
>  create mode 100644 docs/manpages/virtnetworkd.rst
...
> diff --git a/docs/manpages/virtnetworkd.rst b/docs/manpages/virtnetworkd.rst
> new file mode 100644
> index 00..1ef9a12210
> --- /dev/null
> +++ b/docs/manpages/virtnetworkd.rst
> @@ -0,0 +1,215 @@
...
> +EXAMPLES
> +
> +
> +To retrieve the version of ``virtnetworkd``:
> +
> +::
> +
> +  # virtnetworkd --version
> +  virtnetworkd (libvirt) @

Missing VERSION@ at the end of the line.

...

Reviewed-by: Jiri Denemark 



[libvirt PATCH v2 08/16] docs: add manpage for virtnetworkd

2021-01-05 Thread Daniel P . Berrangé
This is an adaptation of the libvirtd manpage.

Signed-off-by: Daniel P. Berrangé 
---
 docs/manpages/index.rst|   1 +
 docs/manpages/meson.build  |   1 +
 docs/manpages/virtnetworkd.rst | 215 +
 3 files changed, 217 insertions(+)
 create mode 100644 docs/manpages/virtnetworkd.rst

diff --git a/docs/manpages/index.rst b/docs/manpages/index.rst
index 0eab1056e4..2ce222f952 100644
--- a/docs/manpages/index.rst
+++ b/docs/manpages/index.rst
@@ -20,6 +20,7 @@ These daemons provide functionality to a single libvirt driver
 * `virtbhyved(8) `__ - libvirt bhyve management daemon
 * `virtinterfaced(8) `__ - libvirt host network interface 
management daemon
 * `virtlxcd(8) `__ - libvirt LXC management daemon
+* `virtnetworkd(8) `__ - libvirt virtual network management 
daemon
 
 Tools
 =
diff --git a/docs/manpages/meson.build b/docs/manpages/meson.build
index 083289642a..4c294909ee 100644
--- a/docs/manpages/meson.build
+++ b/docs/manpages/meson.build
@@ -27,6 +27,7 @@ docs_man_files = [
   { 'name': 'virtlockd', 'section': '8', 'install': conf.has('WITH_LIBVIRTD') 
},
   { 'name': 'virtlogd', 'section': '8', 'install': conf.has('WITH_LIBVIRTD') },
   { 'name': 'virtlxcd', 'section': '8', 'install': conf.has('WITH_LXC') },
+  { 'name': 'virtnetworkd', 'section': '8', 'install': 
conf.has('WITH_NETWORK') },
   { 'name': 'virtproxyd', 'section': '8', 'install': conf.has('WITH_LIBVIRTD') 
},
 ]
 
diff --git a/docs/manpages/virtnetworkd.rst b/docs/manpages/virtnetworkd.rst
new file mode 100644
index 00..1ef9a12210
--- /dev/null
+++ b/docs/manpages/virtnetworkd.rst
@@ -0,0 +1,215 @@
+
+virtnetworkd
+
+
+-
+libvirt virtual network management daemon
+-
+
+:Manual section: 8
+:Manual group: Virtualization Support
+
+.. contents::
+
+SYNOPSIS
+
+
+``virtnetworkd`` [*OPTION*]...
+
+
+DESCRIPTION
+===
+
+The ``virtnetworkd`` 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 virtual
+networks.
+
+The ``virtnetworkd`` 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 ``virtnetworkd`` does not interrupt running guests. Guests continue 
to
+operate and changes in their state will generally be picked up automatically
+during startup. None the less it is recommended to avoid restarting with
+running guests whenever practical.
+
+
+SYSTEM SOCKET ACTIVATION
+
+
+The ``virtnetworkd`` daemon is capable of starting in two modes.
+
+In the traditional mode, it will create and listen on UNIX sockets itself.
+
+In socket activation mode, 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/virtnetworkd.conf`` will no longer have any effect.
+
+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 virtnetworkd.socket virtnetworkd-ro.socket \
+  virtnetworkd-admin.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.
+
+``-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`` ``virtnetworkd`` will reload its configuration.
+
+
+FILES
+=
+
+When run as *root*
+--
+
+* ``@SYSCONFDIR@/libvirt/virtnetworkd.conf``
+
+The default configuration file used by ``virtnetworkd``, unless overridden on 
the
+command line using the ``-f`` | ``--config`` option.
+
+* ``@RUNSTATEDIR@/libvirt/virtnetworkd-sock``
+* ``@RUNSTATEDIR@/libvirt/virtnetworkd-sock-ro``
+* ``@RUNSTATEDIR@/libvirt/virtnetworkd-admin-sock``
+
+The sockets ``virtnetworkd`` will use.
+
+The TLS **Server** private key ``virtnetworkd`` will use.
+
+* ``@RUNSTATEDIR@/virtnetworkd.pid``
+
+The PID file to use, unless overridden by the ``-p`` | ``--pid-file`` option.
+
+
+When run as *non-root*
+--
+
+*