]> xenbits.xensource.com Git - libvirt.git/commitdiff
daemon: move libvirtd POD manpage into src/remote/
authorDaniel P. Berrangé <berrange@redhat.com>
Tue, 20 Feb 2018 14:13:31 +0000 (14:13 +0000)
committerDaniel P. Berrangé <berrange@redhat.com>
Thu, 22 Feb 2018 12:21:09 +0000 (12:21 +0000)
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
daemon/Makefile.am
daemon/libvirtd.pod [deleted file]
src/Makefile.am
src/remote/libvirtd.pod [new file with mode: 0644]

index 69c858e4b4a83da2d110882df89d4e4a1c7eab6f..88a026e56a98f1a62603446c040df44914a23cd9 100644 (file)
 
 CLEANFILES =
 
-PODFILES = \
-       libvirtd.pod \
-       $(NULL)
-
-MANINFILES = \
-       libvirtd.8.in \
-       $(NULL)
-
 DISTCLEANFILES =
 EXTRA_DIST = \
        libvirtd.conf \
@@ -45,16 +37,12 @@ EXTRA_DIST = \
        libvirtd.libxl.logrotate.in \
        libvirtd.uml.logrotate.in \
        test_libvirtd.aug.in \
-       $(PODFILES) \
-       $(MANINFILES) \
        $(NULL)
 
 BUILT_SOURCES =
 
 if WITH_LIBVIRTD
 
-man8_MANS = libvirtd.8
-
 confdir = $(sysconfdir)/libvirt/
 conf_DATA = libvirtd.conf
 
@@ -300,25 +288,6 @@ install-data-local: install-data-sasl
 uninstall-local:: uninstall-data-sasl
 endif ! WITH_LIBVIRTD
 
-POD2MAN = pod2man -c "Virtualization Support" -r "$(PACKAGE)-$(VERSION)"
-
-%.8.in: %.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|LOCALSTATEDIR|\@localstatedir\@|g' \
-               < $@-t1 > $@-t2 && \
-       rm -f $@-t1 && \
-       mv $@-t2 $@
-
-%.8: %.8.in $(top_srcdir)/configure.ac
-       $(AM_V_GEN)sed \
-               -e 's|[@]sysconfdir[@]|$(sysconfdir)|g' \
-               -e 's|[@]localstatedir[@]|$(localstatedir)|g' \
-               < $< > $@-t && \
-       mv $@-t $@
-
 # This is needed for clients too, so can't wrap in
 # the WITH_LIBVIRTD conditional
 if WITH_SASL
@@ -336,6 +305,5 @@ uninstall-data-sasl:
 endif ! WITH_SASL
 
 
-CLEANFILES += $(BUILT_SOURCES) $(man8_MANS)
+CLEANFILES += $(BUILT_SOURCES)
 CLEANFILES += *.cov *.gcov .libs/*.gcda .libs/*.gcno *.gcno *.gcda
-MAINTAINERCLEANFILES = $(MANINFILES)
diff --git a/daemon/libvirtd.pod b/daemon/libvirtd.pod
deleted file mode 100644 (file)
index 4721e0f..0000000
+++ /dev/null
@@ -1,204 +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 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.
-
-=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<LOCALSTATEDIR/run/libvirt/libvirt-sock>
-
-=item F<LOCALSTATEDIR/run/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<LOCALSTATEDIR/run/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 LOCALSTATEDIR/run/libvirtd.pid
- -rw-r--r-- 1 root root 6 Jul  9 02:40 LOCALSTATEDIR/run/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
index 7bdcb1113aba2f9ab4f7d8ec4b042f244d1592bf..e1a9faa5450981108592bf6c26b8b33058d76136 100644 (file)
@@ -2865,6 +2865,16 @@ virtlogd.8.in: logging/virtlogd.pod
        rm -f $@-t1 && \
        mv $@-t2 $@
 
+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|LOCALSTATEDIR|\@localstatedir\@|g' \
+               < $@-t1 > $@-t2 && \
+       rm -f $@-t1 && \
+       mv $@-t2 $@
+
 %.8: %.8.in $(top_srcdir)/configure.ac
        $(AM_V_GEN)sed \
                -e 's|[@]sysconfdir[@]|$(sysconfdir)|g' \
@@ -2873,7 +2883,7 @@ virtlogd.8.in: logging/virtlogd.pod
        mv $@-t $@
 
 if WITH_LIBVIRTD
-man8_MANS = virtlockd.8 virtlogd.8
+man8_MANS = virtlockd.8 virtlogd.8 libvirtd.8
 
 conf_DATA += locking/virtlockd.conf logging/virtlogd.conf
 
@@ -2884,11 +2894,13 @@ endif WITH_LIBVIRTD
 PODFILES = \
        locking/virtlockd.pod \
        logging/virtlogd.pod \
+       remote/libvirtd.pod \
        $(NULL)
 
 MANINFILES = \
        virtlockd.8.in \
        virtlogd.8.in \
+       libvirtd.8.in \
        $(NULL)
 
 CLEANFILES += test_virtlockd.aug test_virtlogd.aug $(man8_MANS)
diff --git a/src/remote/libvirtd.pod b/src/remote/libvirtd.pod
new file mode 100644 (file)
index 0000000..4721e0f
--- /dev/null
@@ -0,0 +1,204 @@
+=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 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.
+
+=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<LOCALSTATEDIR/run/libvirt/libvirt-sock>
+
+=item F<LOCALSTATEDIR/run/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<LOCALSTATEDIR/run/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 LOCALSTATEDIR/run/libvirtd.pid
+ -rw-r--r-- 1 root root 6 Jul  9 02:40 LOCALSTATEDIR/run/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