|
 |
43fe83 |
From 69da992ba2381c0a8e49c5c05c3f8f5d3f0b5407 Mon Sep 17 00:00:00 2001
|
|
|
43fe83 |
Message-Id: <69da992ba2381c0a8e49c5c05c3f8f5d3f0b5407.1377873638.git.jdenemar@redhat.com>
|
|
|
43fe83 |
From: "Daniel P. Berrange" <berrange@redhat.com>
|
|
|
43fe83 |
Date: Tue, 13 Aug 2013 11:35:59 +0100
|
|
|
43fe83 |
Subject: [PATCH] Add a man page for virtlockd daemon
|
|
|
43fe83 |
|
|
|
43fe83 |
For https://bugzilla.redhat.com/show_bug.cgi?id=991494
|
|
|
43fe83 |
|
|
|
43fe83 |
Create a virtlockd.pod.in file containing the man page
|
|
|
43fe83 |
content for virtlockd.
|
|
|
43fe83 |
|
|
|
43fe83 |
Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
|
|
|
43fe83 |
(cherry picked from commit 6ff0cffd55dae2fa07e6e8dc844312a87946678c)
|
|
|
43fe83 |
---
|
|
|
43fe83 |
.gitignore | 2 +
|
|
|
43fe83 |
libvirt.spec.in | 1 +
|
|
|
43fe83 |
src/Makefile.am | 24 ++++++-
|
|
|
43fe83 |
src/locking/virtlockd.pod.in | 158 +++++++++++++++++++++++++++++++++++++++++++
|
|
|
43fe83 |
4 files changed, 184 insertions(+), 1 deletion(-)
|
|
|
43fe83 |
create mode 100644 src/locking/virtlockd.pod.in
|
|
|
43fe83 |
|
|
|
43fe83 |
diff --git a/src/Makefile.am b/src/Makefile.am
|
|
|
43fe83 |
index 62e427e..5a7e05a 100644
|
|
|
43fe83 |
--- a/src/Makefile.am
|
|
|
43fe83 |
+++ b/src/Makefile.am
|
|
|
43fe83 |
@@ -1997,9 +1997,31 @@ virtlockd.init: locking/virtlockd.init.in $(top_builddir)/config.status
|
|
|
43fe83 |
chmod a+x $@-t && \
|
|
|
43fe83 |
mv $@-t $@
|
|
|
43fe83 |
|
|
|
43fe83 |
+POD2MAN = pod2man -c "Virtualization Support" \
|
|
|
43fe83 |
+ -r "$(PACKAGE)-$(VERSION)" -s 8
|
|
|
43fe83 |
|
|
|
43fe83 |
+$(srcdir)/virtlockd.8.in: locking/virtlockd.pod.in $(top_srcdir)/configure.ac
|
|
|
43fe83 |
+ $(AM_V_GEN)$(POD2MAN) --name VIRTLOCKD $< $@ \
|
|
|
43fe83 |
+ && if grep 'POD ERROR' $@ ; then rm $@; exit 1; fi
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+virtlockd.8: $(srcdir)/virtlockd.8.in
|
|
|
43fe83 |
+ $(AM_V_GEN)sed \
|
|
|
43fe83 |
+ -e 's|[@]sysconfdir[@]|$(sysconfdir)|g' \
|
|
|
43fe83 |
+ -e 's|[@]localstatedir[@]|$(localstatedir)|g' \
|
|
|
43fe83 |
+ < $< > $@-t && \
|
|
|
43fe83 |
+ mv $@-t $@
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+man8_MANS = virtlockd.8
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+MAINTAINERCLEANFILES += $(srcdir)/virtlockd.8.in
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+EXTRA_DIST += \
|
|
|
43fe83 |
+ locking/virtlockd.service.in \
|
|
|
43fe83 |
+ locking/virtlockd.socket.in \
|
|
|
43fe83 |
+ locking/virtlockd.pod.in \
|
|
|
43fe83 |
+ virtlockd.8.in \
|
|
|
43fe83 |
+ $(NULL)
|
|
|
43fe83 |
|
|
|
43fe83 |
-EXTRA_DIST += locking/virtlockd.service.in locking/virtlockd.socket.in
|
|
|
43fe83 |
|
|
|
43fe83 |
if WITH_LIBVIRTD
|
|
|
43fe83 |
if LIBVIRT_INIT_SCRIPT_SYSTEMD
|
|
|
43fe83 |
diff --git a/src/locking/virtlockd.pod.in b/src/locking/virtlockd.pod.in
|
|
|
43fe83 |
new file mode 100644
|
|
|
43fe83 |
index 0000000..f5748ca
|
|
|
43fe83 |
--- /dev/null
|
|
|
43fe83 |
+++ b/src/locking/virtlockd.pod.in
|
|
|
43fe83 |
@@ -0,0 +1,158 @@
|
|
|
43fe83 |
+=head1 NAME
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+virtlockd - libvirt lock management daemon
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=head1 SYNOPSIS
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+B<virtlockd> [ -dv ] [ -f config_file ] [ -p pid_file ]
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+B<virtlockd> --version
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=head1 DESCRIPTION
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+The B<virtlockd> program is a server side daemon component of the libvirt
|
|
|
43fe83 |
+virtualization management system that is used to manage locks held against
|
|
|
43fe83 |
+virtual machine resources, such as their disks.
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+This daemon is not used directly by libvirt client applications, rather it
|
|
|
43fe83 |
+is called on their behalf by B<libvirtd>. By maintaining the locks in a
|
|
|
43fe83 |
+standalone daemon, the main libvirtd daemon can be restarted without risk
|
|
|
43fe83 |
+of losing locks. The B<virtlockd> daemon has the ability to re-exec()
|
|
|
43fe83 |
+itself upon receiving SIGUSR1, to allow live upgrades without downtime.
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+The virtlockd daemon listens for requests on a local Unix domain socket.
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=head1 OPTIONS
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=over
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=item B<-d, --daemon>
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+Run as a daemon and write PID file.
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=item B<-f, --config> I<FILE>
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+Use this configuration file, overriding the default value.
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=item B<-p, --pid-file> I<FILE>
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+Use this name for the PID file, overriding the default value.
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=item B<-v, --verbose>
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+Enable output of verbose messages.
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=item B< --version>
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+Display version information then exit.
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=back
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=head1 SIGNALS
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+On receipt of B<SIGUSR1> virtlockd will re-exec() its binary, while
|
|
|
43fe83 |
+maintaining all current locks and clients. This allows for live
|
|
|
43fe83 |
+upgrades of the virtlockd service.
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=head1 FILES
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=head2 When run as B<root>.
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=over
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=item F<SYSCONFDIR/virtlockd.conf>
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+The default configuration file used by virtlockd, unless overridden on the
|
|
|
43fe83 |
+command line using the B<-f>|B<--config> option.
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=item F<LOCALSTATEDIR/run/libvirt/virtlockd-sock>
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+The sockets libvirtd will use.
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=item F<LOCALSTATEDIR/run/virtlockd.pid>
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+The PID file to use, unless overridden by the B<-p>|B<--pid-file> option.
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=back
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=head2 When run as B<non-root>.
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=over
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=item F<$XDG_CONFIG_HOME/virtlockd.conf>
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+The default configuration file used by libvirtd, unless overridden on the
|
|
|
43fe83 |
+command line using the B<-f>|B<--config> option.
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=item F<$XDG_RUNTIME_DIR/libvirt/virtlockd-sock>
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+The socket libvirtd will use.
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=item F<$XDG_RUNTIME_DIR/libvirt/virtlockd.pid>
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+The PID file to use, unless overridden by the B<-p>|B<--pid-file> option.
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=item If $XDG_CONFIG_HOME is not set in your environment, libvirtd will use F<$HOME/.config>
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=item If $XDG_RUNTIME_DIR is not set in your environment, libvirtd will use F<$HOME/.cache>
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=back
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=head1 EXAMPLES
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+To retrieve the version of virtlockd:
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+ # virtlockd --version
|
|
|
43fe83 |
+ virtlockd (libvirt) 1.1.1
|
|
|
43fe83 |
+ #
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+To start virtlockd, instructing it to daemonize and create a PID file:
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+ # virtlockd -d
|
|
|
43fe83 |
+ # ls -la LOCALSTATEDIR/run/virtlockd.pid
|
|
|
43fe83 |
+ -rw-r--r-- 1 root root 6 Jul 9 02:40 LOCALSTATEDIR/run/virtlockd.pid
|
|
|
43fe83 |
+ #
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=head1 BUGS
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+Please report all bugs you discover. This should be done via either:
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=over
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=item a) the mailing list
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+L<http://libvirt.org/contact.html>
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=item or,
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+B<>
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=item b) the bug tracker
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+L<http://libvirt.org/bugs.html>
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=item Alternatively, you may report bugs to your software distributor / vendor.
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=back
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=head1 AUTHORS
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+Please refer to the AUTHORS file distributed with libvirt.
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=head1 COPYRIGHT
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+Copyright (C) 2006-2013 Red Hat, Inc., and the authors listed in the
|
|
|
43fe83 |
+libvirt AUTHORS file.
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=head1 LICENSE
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+virtlockd is distributed under the terms of the GNU LGPL v2.1+.
|
|
|
43fe83 |
+This is free software; see the source for copying conditions. There
|
|
|
43fe83 |
+is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
|
|
|
43fe83 |
+PURPOSE
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=head1 SEE ALSO
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+L<libvirtd(8)>, L<http://www.libvirt.org/>
|
|
|
43fe83 |
+
|
|
|
43fe83 |
+=cut
|
|
|
43fe83 |
--
|
|
|
43fe83 |
1.8.3.2
|
|
|
43fe83 |
|