1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
=head1 NAME
virtlockd - libvirt lock management daemon
=head1 SYNOPSIS
B<virtlockd> [I<OPTION>]...
=head1 DESCRIPTION
The B<virtlockd> 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<libvirtd>. By maintaining the locks in a
standalone daemon, the main libvirtd daemon can be restarted without risk
of losing locks. The B<virtlockd> 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<FILE>
Use this configuration file, overriding the default value.
=item B<-t, --timeout> I<SECONDS>
Automatically shutdown after I<SECONDS> have elapsed with
no active client or lock.
=item B<-p, --pid-file> I<FILE>
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<SIGUSR1> 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<root>.
=over
=item F<SYSCONFDIR/virtlockd.conf>
The default configuration file used by virtlockd, unless overridden on the
command line using the B<-f>|B<--config> option.
=item F<LOCALSTATEDIR/run/libvirt/virtlockd-sock>
The sockets libvirtd will use.
=item F<LOCALSTATEDIR/run/virtlockd.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/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<http://libvirt.org/contact.html>
=item or,
B<>
=item b) the bug tracker
L<http://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-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<libvirtd(8)>, L<http://www.libvirt.org/>
=cut
|
