From: Andrea Bolognani Date: Tue, 12 Apr 2016 20:28:27 +0000 (+0200) Subject: build: Standardize on .pod -> .x.in -> .x X-Git-Url: http://xenbits.xensource.com/gitweb?a=commitdiff_plain;h=5b479f3b5b82f25fe74c539009603685b971f8c9;p=libvirt.git build: Standardize on .pod -> .x.in -> .x After this commit, all man pages are generated using the same two steps: 1. Process a source $command.pod file with pod2man(1) to obtain a valid man page in $command.$section.in 2. Process $command.$section.in with sed(1) to obtain the final man page in $command.$section --- diff --git a/daemon/Makefile.am b/daemon/Makefile.am index 32ecd4cca4..d7c21f712f 100644 --- a/daemon/Makefile.am +++ b/daemon/Makefile.am @@ -69,7 +69,7 @@ EXTRA_DIST = \ libvirtd.uml.logrotate.in \ test_libvirtd.aug.in \ THREADS.txt \ - libvirtd.pod.in \ + libvirtd.pod \ libvirtd.8.in \ $(DAEMON_SOURCES) \ $(LIBVIRTD_CONF_SOURCES) \ @@ -161,13 +161,6 @@ augeastests_DATA = test_libvirtd.aug CLEANFILES += test_libvirtd.aug -libvirtd.8: libvirtd.8.in - $(AM_V_GEN)sed \ - -e 's|[@]sysconfdir[@]|$(sysconfdir)|g' \ - -e 's|[@]localstatedir[@]|$(localstatedir)|g' \ - < $< > $@-t && \ - mv $@-t $@ - libvirtd_SOURCES = $(DAEMON_SOURCES) #-D_XOPEN_SOURCE=600 -D_XOPEN_SOURCE_EXTENDED=1 -D_POSIX_C_SOURCE=199506L @@ -504,12 +497,18 @@ install-data-local: install-data-sasl uninstall-local:: uninstall-data-sasl endif ! WITH_LIBVIRTD -POD2MAN = pod2man -c "Virtualization Support" \ - -r "$(PACKAGE)-$(VERSION)" -s 8 +POD2MAN = pod2man -c "Virtualization Support" -r "$(PACKAGE)-$(VERSION)" -libvirtd.8.in: libvirtd.pod.in $(top_srcdir)/configure.ac - $(AM_V_GEN)$(POD2MAN) --name LIBVIRTD $< $@ \ - && if grep 'POD ERROR' $@ ; then rm $@; exit 1; fi +%.8.in: %.pod + $(AM_V_GEN)$(POD2MAN) --section=8 $< $@ \ + && if grep 'POD ERROR' $@ ; then rm $@; exit 1; fi + +%.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 diff --git a/daemon/libvirtd.pod b/daemon/libvirtd.pod new file mode 100644 index 0000000000..9901ecfe51 --- /dev/null +++ b/daemon/libvirtd.pod @@ -0,0 +1,208 @@ +=head1 NAME + +libvirtd - libvirtd management daemon + +=head1 SYNOPSIS + +B [ -dlv ] [ -f config_file ] [ -p pid_file ] [ -t timeout_seconds ] + +B --version + +=head1 DESCRIPTION + +The B 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 + +Use this configuration file, overriding the default value. + +=item B<-l, --listen> + +Listen for TCP/IP connections. + +=item B<-p, --pid-file> I + +Use this name for the PID file, overriding the default value. + +=item B<-t, --timeout> I + +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. + +=item B<-v, --verbose> + +Enable output of verbose messages. + +=item B< --version> + +Display version information then exit. + +=back + +=head1 SIGNALS + +On receipt of B libvirtd will reload its configuration. + +=head1 FILES + +=head2 When run as B. + +=over + +=item F + +The default configuration file used by libvirtd, unless overridden on the +command line using the B<-f>|B<--config> option. + +=item F + +=item F + +The sockets libvirtd will use. + +=item F + +The TLS B certificate libvirtd will use. + +=item F + +The TLS B certificate libvirtd will use. + +=item F + +The TLS B private key libvirtd will use. + +=item F + +The PID file to use, unless overridden by the B<-p>|B<--pid-file> option. + +=back + +=head2 When run as B. + +=over + +=item F<$XDG_CONFIG_HOME/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 libvirtd will use. + +=item F<$HOME/.pki/libvirt/servercert.pem> + +The TLS B certificate libvirtd will use. + +=item F<$HOME/.pki/libvirt/serverkey.pem> + +The TLS B 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 + +=item or, + +B<> + +=item b) the bug tracker + +L + +=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, L, L, L, +L, L + +=cut diff --git a/daemon/libvirtd.pod.in b/daemon/libvirtd.pod.in deleted file mode 100644 index 9901ecfe51..0000000000 --- a/daemon/libvirtd.pod.in +++ /dev/null @@ -1,208 +0,0 @@ -=head1 NAME - -libvirtd - libvirtd management daemon - -=head1 SYNOPSIS - -B [ -dlv ] [ -f config_file ] [ -p pid_file ] [ -t timeout_seconds ] - -B --version - -=head1 DESCRIPTION - -The B 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 - -Use this configuration file, overriding the default value. - -=item B<-l, --listen> - -Listen for TCP/IP connections. - -=item B<-p, --pid-file> I - -Use this name for the PID file, overriding the default value. - -=item B<-t, --timeout> I - -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. - -=item B<-v, --verbose> - -Enable output of verbose messages. - -=item B< --version> - -Display version information then exit. - -=back - -=head1 SIGNALS - -On receipt of B libvirtd will reload its configuration. - -=head1 FILES - -=head2 When run as B. - -=over - -=item F - -The default configuration file used by libvirtd, unless overridden on the -command line using the B<-f>|B<--config> option. - -=item F - -=item F - -The sockets libvirtd will use. - -=item F - -The TLS B certificate libvirtd will use. - -=item F - -The TLS B certificate libvirtd will use. - -=item F - -The TLS B private key libvirtd will use. - -=item F - -The PID file to use, unless overridden by the B<-p>|B<--pid-file> option. - -=back - -=head2 When run as B. - -=over - -=item F<$XDG_CONFIG_HOME/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 libvirtd will use. - -=item F<$HOME/.pki/libvirt/servercert.pem> - -The TLS B certificate libvirtd will use. - -=item F<$HOME/.pki/libvirt/serverkey.pem> - -The TLS B 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 - -=item or, - -B<> - -=item b) the bug tracker - -L - -=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, L, L, L, -L, L - -=cut diff --git a/src/Makefile.am b/src/Makefile.am index 11f2731014..238363cc3c 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -2562,29 +2562,21 @@ virtlogd.init: logging/virtlogd.init.in $(top_builddir)/config.status chmod a+x $@-t && \ mv $@-t $@ -POD2MAN = pod2man -c "Virtualization Support" \ - -r "$(PACKAGE)-$(VERSION)" -s 8 +POD2MAN = pod2man -c "Virtualization Support" -r "$(PACKAGE)-$(VERSION)" -virtlockd.8.in: locking/virtlockd.pod.in $(top_srcdir)/configure.ac - $(AM_V_GEN)$(POD2MAN) --name VIRTLOCKD $< $@ \ - && if grep 'POD ERROR' $@ ; then rm $@; exit 1; fi +virtlockd.8.in: locking/virtlockd.pod + $(AM_V_GEN)$(POD2MAN) --section 8 $< $@ \ + && if grep 'POD ERROR' $@ ; then rm $@; exit 1; fi -virtlockd.8: virtlockd.8.in - $(AM_V_GEN)sed \ - -e 's|[@]sysconfdir[@]|$(sysconfdir)|g' \ - -e 's|[@]localstatedir[@]|$(localstatedir)|g' \ - < $< > $@-t && \ - mv $@-t $@ - -virtlogd.8.in: logging/virtlogd.pod.in $(top_srcdir)/configure.ac - $(AM_V_GEN)$(POD2MAN) --name VIRTLOGD $< $@ \ - && if grep 'POD ERROR' $@ ; then rm $@; exit 1; fi +virtlogd.8.in: logging/virtlogd.pod + $(AM_V_GEN)$(POD2MAN) --section 8 $< $@ \ + && if grep 'POD ERROR' $@ ; then rm $@; exit 1; fi -virtlogd.8: virtlogd.8.in +%.8: %.8.in $(top_srcdir)/configure.ac $(AM_V_GEN)sed \ - -e 's|[@]sysconfdir[@]|$(sysconfdir)|g' \ - -e 's|[@]localstatedir[@]|$(localstatedir)|g' \ - < $< > $@-t && \ + -e 's|[@]sysconfdir[@]|$(sysconfdir)|g' \ + -e 's|[@]localstatedir[@]|$(localstatedir)|g' \ + < $< > $@-t && \ mv $@-t $@ if WITH_LIBVIRTD @@ -2603,14 +2595,14 @@ MAINTAINERCLEANFILES += virtlockd.8.in virtlogd.8.in EXTRA_DIST += \ locking/virtlockd.service.in \ locking/virtlockd.socket.in \ - locking/virtlockd.pod.in \ + locking/virtlockd.pod \ virtlockd.8.in \ locking/virtlockd.aug \ locking/virtlockd.conf \ locking/test_virtlockd.aug.in \ logging/virtlogd.service.in \ logging/virtlogd.socket.in \ - logging/virtlogd.pod.in \ + logging/virtlogd.pod \ virtlogd.8.in \ logging/virtlogd.aug \ logging/virtlogd.conf \ diff --git a/src/locking/virtlockd.pod b/src/locking/virtlockd.pod new file mode 100644 index 0000000000..661473ccc9 --- /dev/null +++ b/src/locking/virtlockd.pod @@ -0,0 +1,167 @@ +=head1 NAME + +virtlockd - libvirt lock management daemon + +=head1 SYNOPSIS + +B [ -dvV ] [ -t timeout] [ -f config_file ] [ -p pid_file ] + +B --version + +=head1 DESCRIPTION + +The B program is a server side daemon component of the libvirt +virtualization management system that is used to manage locks held against +virtual machine resources, such as their disks. + +This daemon is not used directly by libvirt client applications, rather it +is called on their behalf by B. By maintaining the locks in a +standalone daemon, the main libvirtd daemon can be restarted without risk +of losing locks. The B daemon has the ability to re-exec() +itself upon receiving SIGUSR1, to allow live upgrades without downtime. + +The virtlockd daemon listens for requests on a local Unix domain socket. + +=head1 OPTIONS + +=over + +=item B<-h, --help> + +Display command line help usage then exit. + +=item B<-d, --daemon> + +Run as a daemon and write PID file. + +=item B<-f, --config> I + +Use this configuration file, overriding the default value. + +=item B<-t, --timeout> I + +Automatically shutdown after I have elapsed with +no active client or lock. + +=item B<-p, --pid-file> I + +Use this name for the PID file, overriding the default value. + +=item B<-v, --verbose> + +Enable output of verbose messages. + +=item B<-V, --version> + +Display version information then exit. + +=back + +=head1 SIGNALS + +On receipt of B virtlockd will re-exec() its binary, while +maintaining all current locks and clients. This allows for live +upgrades of the virtlockd service. + +=head1 FILES + +=head2 When run as B. + +=over + +=item F + +The default configuration file used by virtlockd, unless overridden on the +command line using the B<-f>|B<--config> option. + +=item F + +The sockets libvirtd will use. + +=item F + +The PID file to use, unless overridden by the B<-p>|B<--pid-file> option. + +=back + +=head2 When run as B. + +=over + +=item F<$XDG_CONFIG_HOME/virtlockd.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/virtlockd-sock> + +The socket libvirtd will use. + +=item F<$XDG_RUNTIME_DIR/libvirt/virtlockd.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 virtlockd: + + # virtlockd --version + virtlockd (libvirt) 1.1.1 + # + +To start virtlockd, instructing it to daemonize and create a PID file: + + # virtlockd -d + # ls -la LOCALSTATEDIR/run/virtlockd.pid + -rw-r--r-- 1 root root 6 Jul 9 02:40 LOCALSTATEDIR/run/virtlockd.pid + # + +=head1 BUGS + +Please report all bugs you discover. This should be done via either: + +=over + +=item a) the mailing list + +L + +=item or, + +B<> + +=item b) the bug tracker + +L + +=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-2013 Red Hat, Inc., and the authors listed in the +libvirt AUTHORS file. + +=head1 LICENSE + +virtlockd 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, L + +=cut diff --git a/src/locking/virtlockd.pod.in b/src/locking/virtlockd.pod.in deleted file mode 100644 index 661473ccc9..0000000000 --- a/src/locking/virtlockd.pod.in +++ /dev/null @@ -1,167 +0,0 @@ -=head1 NAME - -virtlockd - libvirt lock management daemon - -=head1 SYNOPSIS - -B [ -dvV ] [ -t timeout] [ -f config_file ] [ -p pid_file ] - -B --version - -=head1 DESCRIPTION - -The B program is a server side daemon component of the libvirt -virtualization management system that is used to manage locks held against -virtual machine resources, such as their disks. - -This daemon is not used directly by libvirt client applications, rather it -is called on their behalf by B. By maintaining the locks in a -standalone daemon, the main libvirtd daemon can be restarted without risk -of losing locks. The B daemon has the ability to re-exec() -itself upon receiving SIGUSR1, to allow live upgrades without downtime. - -The virtlockd daemon listens for requests on a local Unix domain socket. - -=head1 OPTIONS - -=over - -=item B<-h, --help> - -Display command line help usage then exit. - -=item B<-d, --daemon> - -Run as a daemon and write PID file. - -=item B<-f, --config> I - -Use this configuration file, overriding the default value. - -=item B<-t, --timeout> I - -Automatically shutdown after I have elapsed with -no active client or lock. - -=item B<-p, --pid-file> I - -Use this name for the PID file, overriding the default value. - -=item B<-v, --verbose> - -Enable output of verbose messages. - -=item B<-V, --version> - -Display version information then exit. - -=back - -=head1 SIGNALS - -On receipt of B virtlockd will re-exec() its binary, while -maintaining all current locks and clients. This allows for live -upgrades of the virtlockd service. - -=head1 FILES - -=head2 When run as B. - -=over - -=item F - -The default configuration file used by virtlockd, unless overridden on the -command line using the B<-f>|B<--config> option. - -=item F - -The sockets libvirtd will use. - -=item F - -The PID file to use, unless overridden by the B<-p>|B<--pid-file> option. - -=back - -=head2 When run as B. - -=over - -=item F<$XDG_CONFIG_HOME/virtlockd.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/virtlockd-sock> - -The socket libvirtd will use. - -=item F<$XDG_RUNTIME_DIR/libvirt/virtlockd.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 virtlockd: - - # virtlockd --version - virtlockd (libvirt) 1.1.1 - # - -To start virtlockd, instructing it to daemonize and create a PID file: - - # virtlockd -d - # ls -la LOCALSTATEDIR/run/virtlockd.pid - -rw-r--r-- 1 root root 6 Jul 9 02:40 LOCALSTATEDIR/run/virtlockd.pid - # - -=head1 BUGS - -Please report all bugs you discover. This should be done via either: - -=over - -=item a) the mailing list - -L - -=item or, - -B<> - -=item b) the bug tracker - -L - -=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-2013 Red Hat, Inc., and the authors listed in the -libvirt AUTHORS file. - -=head1 LICENSE - -virtlockd 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, L - -=cut diff --git a/src/logging/virtlogd.pod b/src/logging/virtlogd.pod new file mode 100644 index 0000000000..ce57f95dfc --- /dev/null +++ b/src/logging/virtlogd.pod @@ -0,0 +1,167 @@ +=head1 NAME + +virtlogd - libvirt log management daemon + +=head1 SYNOPSIS + +B [ -dvV ] [-t timeout] [ -f config_file ] [ -p pid_file ] + +B --version + +=head1 DESCRIPTION + +The B program is a server side daemon component of the libvirt +virtualization management system that is used to manage logs from virtual +machine consoles. + +This daemon is not used directly by libvirt client applications, rather it +is called on their behalf by B. By maintaining the logs in a +standalone daemon, the main libvirtd daemon can be restarted without risk +of losing logs. The B daemon has the ability to re-exec() +itself upon receiving SIGUSR1, to allow live upgrades without downtime. + +The virtlogd daemon listens for requests on a local Unix domain socket. + +=head1 OPTIONS + +=over + +=item B<-h, --help> + +Display command line help usage then exit. + +=item B<-d, --daemon> + +Run as a daemon and write PID file. + +=item B<-f, --config> I + +Use this configuration file, overriding the default value. + +=item B<-t, --timeout> I + +Automatically shutdown after I have elapsed with +no active console log. + +=item B<-p, --pid-file> I + +Use this name for the PID file, overriding the default value. + +=item B<-v, --verbose> + +Enable output of verbose messages. + +=item B<-V, --version> + +Display version information then exit. + +=back + +=head1 SIGNALS + +On receipt of B virtlogd will re-exec() its binary, while +maintaining all current logs and clients. This allows for live +upgrades of the virtlogd service. + +=head1 FILES + +=head2 When run as B. + +=over + +=item F + +The default configuration file used by virtlogd, unless overridden on the +command line using the B<-f>|B<--config> option. + +=item F + +The sockets libvirtd will use. + +=item F + +The PID file to use, unless overridden by the B<-p>|B<--pid-file> option. + +=back + +=head2 When run as B. + +=over + +=item F<$XDG_CONFIG_HOME/virtlogd.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/virtlogd-sock> + +The socket libvirtd will use. + +=item F<$XDG_RUNTIME_DIR/libvirt/virtlogd.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 virtlogd: + + # virtlogd --version + virtlogd (libvirt) 1.1.1 + # + +To start virtlogd, instructing it to daemonize and create a PID file: + + # virtlogd -d + # ls -la LOCALSTATEDIR/run/virtlogd.pid + -rw-r--r-- 1 root root 6 Jul 9 02:40 LOCALSTATEDIR/run/virtlogd.pid + # + +=head1 BUGS + +Please report all bugs you discover. This should be done via either: + +=over + +=item a) the mailing list + +L + +=item or, + +B<> + +=item b) the bug tracker + +L + +=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-2015 Red Hat, Inc., and the authors listed in the +libvirt AUTHORS file. + +=head1 LICENSE + +virtlogd 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, L + +=cut diff --git a/src/logging/virtlogd.pod.in b/src/logging/virtlogd.pod.in deleted file mode 100644 index ce57f95dfc..0000000000 --- a/src/logging/virtlogd.pod.in +++ /dev/null @@ -1,167 +0,0 @@ -=head1 NAME - -virtlogd - libvirt log management daemon - -=head1 SYNOPSIS - -B [ -dvV ] [-t timeout] [ -f config_file ] [ -p pid_file ] - -B --version - -=head1 DESCRIPTION - -The B program is a server side daemon component of the libvirt -virtualization management system that is used to manage logs from virtual -machine consoles. - -This daemon is not used directly by libvirt client applications, rather it -is called on their behalf by B. By maintaining the logs in a -standalone daemon, the main libvirtd daemon can be restarted without risk -of losing logs. The B daemon has the ability to re-exec() -itself upon receiving SIGUSR1, to allow live upgrades without downtime. - -The virtlogd daemon listens for requests on a local Unix domain socket. - -=head1 OPTIONS - -=over - -=item B<-h, --help> - -Display command line help usage then exit. - -=item B<-d, --daemon> - -Run as a daemon and write PID file. - -=item B<-f, --config> I - -Use this configuration file, overriding the default value. - -=item B<-t, --timeout> I - -Automatically shutdown after I have elapsed with -no active console log. - -=item B<-p, --pid-file> I - -Use this name for the PID file, overriding the default value. - -=item B<-v, --verbose> - -Enable output of verbose messages. - -=item B<-V, --version> - -Display version information then exit. - -=back - -=head1 SIGNALS - -On receipt of B virtlogd will re-exec() its binary, while -maintaining all current logs and clients. This allows for live -upgrades of the virtlogd service. - -=head1 FILES - -=head2 When run as B. - -=over - -=item F - -The default configuration file used by virtlogd, unless overridden on the -command line using the B<-f>|B<--config> option. - -=item F - -The sockets libvirtd will use. - -=item F - -The PID file to use, unless overridden by the B<-p>|B<--pid-file> option. - -=back - -=head2 When run as B. - -=over - -=item F<$XDG_CONFIG_HOME/virtlogd.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/virtlogd-sock> - -The socket libvirtd will use. - -=item F<$XDG_RUNTIME_DIR/libvirt/virtlogd.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 virtlogd: - - # virtlogd --version - virtlogd (libvirt) 1.1.1 - # - -To start virtlogd, instructing it to daemonize and create a PID file: - - # virtlogd -d - # ls -la LOCALSTATEDIR/run/virtlogd.pid - -rw-r--r-- 1 root root 6 Jul 9 02:40 LOCALSTATEDIR/run/virtlogd.pid - # - -=head1 BUGS - -Please report all bugs you discover. This should be done via either: - -=over - -=item a) the mailing list - -L - -=item or, - -B<> - -=item b) the bug tracker - -L - -=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-2015 Red Hat, Inc., and the authors listed in the -libvirt AUTHORS file. - -=head1 LICENSE - -virtlogd 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, L - -=cut diff --git a/tools/Makefile.am b/tools/Makefile.am index 64212d5c40..5b4c9e3bf9 100644 --- a/tools/Makefile.am +++ b/tools/Makefile.am @@ -28,8 +28,6 @@ AM_LDFLAGS = \ $(NO_INDIRECT_LDFLAGS) \ $(NULL) -POD2MAN = pod2man -c "Virtualization Support" -r "$(PACKAGE)-$(VERSION)" - ICON_FILES = \ libvirt_win_icon_16x16.ico \ libvirt_win_icon_32x32.ico \ @@ -273,6 +271,8 @@ virsh_win_icon.$(OBJEXT): virsh_win_icon.rc --output-format coff --output $@ endif WITH_WIN_ICON +POD2MAN = pod2man -c "Virtualization Support" -r "$(PACKAGE)-$(VERSION)" + %.1.in: %.pod $(AM_V_GEN)$(POD2MAN) $< $@ \ && if grep 'POD ERROR' $@ ; then rm $@; exit 1; fi