2:20 p.m.
From: Justin Clift <justin(a)salasaga.org>
Gracious thanks to Chris Lalancette for helping knock the description
section into shape.
This addresses BZ #595350
https://bugzilla.redhat.com/show_bug.cgi?id=595350
---
daemon/Makefile.am | 40 +++++++++++-
daemon/libvirtd.pod.in | 168 ++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 207 insertions(+), 1 deletions(-)
create mode 100644 daemon/libvirtd.pod.in
diff --git a/daemon/Makefile.am b/daemon/Makefile.am
index df34ef1..332e895 100644
--- a/daemon/Makefile.am
+++ b/daemon/Makefile.am
@@ -32,9 +32,12 @@ EXTRA_DIST = \
THREADING.txt \
libvirt-guests.init.in \
libvirt-guests.sysconf \
+ libvirtd.pod.in \
$(AVAHI_SOURCES) \
$(DAEMON_SOURCES)
+man_MANS = libvirtd.8
+
BUILT_SOURCES =
if WITH_LIBVIRTD
@@ -50,6 +53,41 @@ augeas_DATA = libvirtd.aug
augeastestsdir = $(datadir)/augeas/lenses/tests
augeastests_DATA = test_libvirtd.aug
+POD2MAN = pod2man -c "Virtualization Support" -r
"$(PACKAGE)-$(VERSION)" -s 8
+
+if WITH_REMOTE
+libvirtd.pod: libvirtd.pod.in
+ sed \
+ -e 's![@]sysconfdir[@]!$(sysconfdir)!g' \
+ -e 's![@]localstatedir[@]!$(localstatedir)!g' \
+ -e 's![@]tls_line1[@]!=item F<$(sysconfdir)/pki/CA/cacert.pem>!g' \
+ -e 's![@]tls_line2[@]!The TLS B<Certificate Authority> certificate
libvirtd will use.!g' \
+ -e 's![@]tls_line3[@]!=item
F<$(sysconfdir)/pki/libvirt/servercert.pem>!g' \
+ -e 's![@]tls_line4[@]!The TLS B<Server> certificate libvirtd will
use.!g' \
+ -e 's![@]tls_line5[@]!=item
F<$(sysconfdir)/pki/libvirt/private/serverkey.pem>!g' \
+ -e 's![@]tls_line6[@]!The TLS B<Server> private key libvirtd will
use.!g' \
+ -e 's![@]remote_pid_file[@]!$(REMOTE_PID_FILE)!g' \
+ < $< > $@-t
+ mv $@-t $@
+else
+libvirtd.pod: libvirtd.pod.in
+ sed \
+ -e 's![@]sysconfdir[@]!$(sysconfdir)!g' \
+ -e 's![@]localstatedir[@]!$(localstatedir)!g' \
+ -e 's![@]tls_line1[@]!!g' \
+ -e 's![@]tls_line2[@]!!g' \
+ -e 's![@]tls_line3[@]!!g' \
+ -e 's![@]tls_line4[@]!!g' \
+ -e 's![@]tls_line5[@]!!g' \
+ -e 's![@]tls_line6[@]!!g' \
+ -e 's![@]remote_pid_file[@]!$(REMOTE_PID_FILE)!g' \
+ < $< > $@-t
+ mv $@-t $@
+endif
+
+libvirtd.8: libvirtd.pod
+ $(AM_V_GEN)$(POD2MAN) $< $@
+
libvirtd_SOURCES = $(DAEMON_SOURCES)
#-D_XOPEN_SOURCE=600 -D_XOPEN_SOURCE_EXTENDED=1 -D_POSIX_C_SOURCE=199506L
@@ -285,5 +323,5 @@ uninstall-data-sasl:
endif
-CLEANFILES = $(BUILT_SOURCES)
+CLEANFILES = $(BUILT_SOURCES) $(man1_MANS)
CLEANFILES += *.cov *.gcov .libs/*.gcda .libs/*.gcno *.gcno *.gcda
diff --git a/daemon/libvirtd.pod.in b/daemon/libvirtd.pod.in
new file mode 100644
index 0000000..33437c9
--- /dev/null
+++ b/daemon/libvirtd.pod.in
@@ -0,0 +1,168 @@
+=head1 NAME
+
+libvirtd - libvirtd management daemon
+
+=head1 SYNOPSIS
+
+B<libvirtd> [ -dlv ] [ -f config_file ] [ -p pid_file ] [ -t timeout_seconds ]
+
+B<libvirtd> --version
+
+=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<-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) expires.
+
+=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
+
+=over
+
+=item F<@sysconfdir(a)/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 when B<run as root>.
+
+=item F<$HOME/.libvirt/libvirt-sock>
+
+The socket libvirtd will use when run as a B<non-root> user.
+
+@tls_line1@
+
+@tls_line2@
+
+@tls_line3@
+
+@tls_line4@
+
+@tls_line5@
+
+@tls_line6@
+
+=item F<@remote_pid_file@>
+
+The PID file to use, unless overridden by the B<-p>|B<--pid-file> option.
+
+=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 @remote_pid_file@
+ -rw-r--r-- 1 root root 6 Jul 9 02:40 @remote_pid_file@
+ #
+
+=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
+
+ Andrew Puch <apuch @ redhat.com>
+ Daniel Veillard <veillard @ redhat.com>
+
+=head1 COPYRIGHT
+
+Copyright (C) 2010 Red Hat, Inc.
+
+=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-mem(1)>, L<virt-df(1)>, L<http://www.libvirt.org/>
+
+=cut
--
1.7.1
3:14 p.m.
On 07/09/10 - 05:20:27AM, Justin Clift wrote:
From: Justin Clift <justin(a)salasaga.org>
Gracious thanks to Chris Lalancette for helping knock the description
section into shape.
This addresses BZ #595350
https://bugzilla.redhat.com/show_bug.cgi?id=595350
It looks pretty good to me; a few comments inline.
diff --git a/daemon/Makefile.am b/daemon/Makefile.am
index df34ef1..332e895 100644
--- a/daemon/Makefile.am
+++ b/daemon/Makefile.am
...
@@ -50,6 +53,41 @@ augeas_DATA = libvirtd.aug
augeastestsdir = $(datadir)/augeas/lenses/tests
augeastests_DATA = test_libvirtd.aug
+POD2MAN = pod2man -c "Virtualization Support" -r
"$(PACKAGE)-$(VERSION)" -s 8
+
+if WITH_REMOTE
+libvirtd.pod: libvirtd.pod.in
+ sed \
+ -e 's![@]sysconfdir[@]!$(sysconfdir)!g' \
+ -e 's![@]localstatedir[@]!$(localstatedir)!g' \
+ -e 's![@]tls_line1[@]!=item F<$(sysconfdir)/pki/CA/cacert.pem>!g' \
+ -e 's![@]tls_line2[@]!The TLS B<Certificate Authority> certificate
libvirtd will use.!g' \
+ -e 's![@]tls_line3[@]!=item
F<$(sysconfdir)/pki/libvirt/servercert.pem>!g' \
+ -e 's![@]tls_line4[@]!The TLS B<Server> certificate libvirtd will
use.!g' \
+ -e 's![@]tls_line5[@]!=item
F<$(sysconfdir)/pki/libvirt/private/serverkey.pem>!g' \
+ -e 's![@]tls_line6[@]!The TLS B<Server> private key libvirtd will
use.!g' \
+ -e 's![@]remote_pid_file[@]!$(REMOTE_PID_FILE)!g' \
+ < $< > $@-t
+ mv $@-t $@
+else
+libvirtd.pod: libvirtd.pod.in
+ sed \
+ -e 's![@]sysconfdir[@]!$(sysconfdir)!g' \
+ -e 's![@]localstatedir[@]!$(localstatedir)!g' \
+ -e 's![@]tls_line1[@]!!g' \
+ -e 's![@]tls_line2[@]!!g' \
+ -e 's![@]tls_line3[@]!!g' \
+ -e 's![@]tls_line4[@]!!g' \
+ -e 's![@]tls_line5[@]!!g' \
+ -e 's![@]tls_line6[@]!!g' \
+ -e 's![@]remote_pid_file[@]!$(REMOTE_PID_FILE)!g' \
+ < $< > $@-t
+ mv $@-t $@
+endif
While this is fun and tricky, I'm not 100% convinced that we should do this.
I would think we would want the same manpage regardless of what options are
compiled in. While it could be a bit confusing in that options are listed
in the manpage that aren't actually available in this build, it's at least
consistent. Though I could be convinced otherwise.
<snip>
diff --git a/daemon/libvirtd.pod.in b/daemon/libvirtd.pod.in
new file mode 100644
index 0000000..33437c9
--- /dev/null
+++ b/daemon/libvirtd.pod.in
@@ -0,0 +1,168 @@
...
+=head1 AUTHORS
+
+ Andrew Puch <apuch @ redhat.com>
+ Daniel Veillard <veillard @ redhat.com>
This isn't really right, despite what the source comments might say :). From
a "git annotate daemon/libvirtd.c", I see at least:
Daniel P. Berrange
Jim Meyering
Mark McLoughlin
Richard W.M. Jones
Eric Blake
Stefan Berger
Matthias Bolte
John Levon
Daniel Veillard
Chris Lalancette
Jiri Denemark
Cole Robinson
Atsushi SAKAI
Amy Griffis
Guido Günther
+
+=head1 COPYRIGHT
+
+Copyright (C) 2010 Red Hat, Inc.
+
I'm definitely not a copyright guy, so I'm not sure. I know we have headers
that say this, but as far as I know we don't have copyright assignment for
libvirt. Given the list of authors above, I'm not sure if this is correct or
not.
--
Chris Lalancette
4:07 p.m.
On 07/09/2010 06:14 AM, Chris Lalancette wrote:
<snip>
While this is fun and tricky, I'm not 100% convinced that we
should do this.
I would think we would want the same manpage regardless of what options are
compiled in. While it could be a bit confusing in that options are listed
in the manpage that aren't actually available in this build, it's at least
consistent. Though I could be convinced otherwise.
I'm ok either way. :)
<snip>
> +=head1 AUTHORS
> +
> + Andrew Puch<apuch @ redhat.com>
> + Daniel Veillard<veillard @ redhat.com>
This isn't really right, despite what the source comments might say :). From
a "git annotate daemon/libvirtd.c", I see at least:
Maybe just reference the Libvirt Community or something, plus give the URL?
<snip>
> +=head1 COPYRIGHT
> +
> +Copyright (C) 2010 Red Hat, Inc.
> +
I'm definitely not a copyright guy, so I'm not sure. I know we have headers
that say this, but as far as I know we don't have copyright assignment for
libvirt. Given the list of authors above, I'm not sure if this is correct or
not.
I just copied from virsh's man page, plus removed the old years.
Should we ask (Red Hat?) legal people for guidance here?
Regards and best wishes,
Justin Clift
7:33 a.m.
On 07/09/10 - 07:07:23AM, Justin Clift wrote:
On 07/09/2010 06:14 AM, Chris Lalancette wrote:
<snip>
>While this is fun and tricky, I'm not 100% convinced that we should do this.
>I would think we would want the same manpage regardless of what options are
>compiled in. While it could be a bit confusing in that options are listed
>in the manpage that aren't actually available in this build, it's at least
>consistent. Though I could be convinced otherwise.
I'm ok either way. :)
<snip>
>>+=head1 AUTHORS
>>+
>>+ Andrew Puch<apuch @ redhat.com>
>>+ Daniel Veillard<veillard @ redhat.com>
>
>This isn't really right, despite what the source comments might say :). From
>a "git annotate daemon/libvirtd.c", I see at least:
Maybe just reference the Libvirt Community or something, plus give the URL?
Yeah, that sounds like a good idea.
<snip>
>>+=head1 COPYRIGHT
>>+
>>+Copyright (C) 2010 Red Hat, Inc.
>>+
>
>I'm definitely not a copyright guy, so I'm not sure. I know we have headers
>that say this, but as far as I know we don't have copyright assignment for
>libvirt. Given the list of authors above, I'm not sure if this is correct or
>not.
I just copied from virsh's man page, plus removed the old years.
Yeah, I'm just not sure what the right answer here is. Maybe we just remove
the COPYRIGHT section altogether for now?
--
Chris Lalancette
8:33 a.m.
On 07/09/2010 10:33 PM, Chris Lalancette wrote:
<snip>
>> This isn't really right, despite what the source comments
might say :). From
>> a "git annotate daemon/libvirtd.c", I see at least:
>
> Maybe just reference the Libvirt Community or something, plus give the URL?
Yeah, that sounds like a good idea.
Went with plan b), being to just all the authors from the git annotate
command instead.
<snip>
Yeah, I'm just not sure what the right answer here is. Maybe we
just remove
the COPYRIGHT section altogether for now?
Submitted a new patch, referencing the authors. Can just remove the
copyright section though, if that's better?
****************************************************************
+=head1 AUTHORS
+
+ Stefan Berger <stefanb(a)us.ibm.com>
+ Daniel Berrange <berrange(a)redhat.com>
+ Eric Blake <eblake(a)redhat.com>
+ Matthias Bolte <matthias.bolte(a)googlemail.com>
+ Jiri Denemark <jdenemar(a)redhat.com>
+ Amy Griffis <amy.griffis(a)hp.com>
+ Guido Günther <agx(a)sigxcpu.org>
+ Richard W.M. Jones <rjones(a)redhat.com>
+ Dan Kenigsberg <danken(a)redhat.com>
+ Chris Lalancette <clalance(a)redhat.com>
+ Dave Leskovec <dlesko(a)linux.vnet.ibm.com>
+ John Levon <john.levon(a)sun.com>
+ Wolfgang Mauerer <wolfgang.mauerer(a)siemens.com>
+ Mark McLoughlin <markmc(a)redhat.com>
+ Jim Meyering <meyering(a)redhat.com>
+ Cole Robinson <crobinso(a)redhat.com>
+ Atsushi SAKAI <sakaia(a)jp.fujitsu.com>
+ Laine Stump <laine(a)redhat.com>
+ Miloslav Trmač <mitr(a)redhat.com>
+ Daniel Veillard <veillard(a)redhat.com> or <daniel(a)veillard.com>
+
+=head1 COPYRIGHT
+
+Copyright (C) 2006-2010 Red Hat, Inc. and the above mentioned AUTHORS.
****************************************************************
Regards and best wishes,
Justin Clift
5:26 a.m.
New subject: [libvirt] [PATCHv2] libvirtd: add man page for libvirtd
With gracious thanks to Chris Lalancette for helping knock the
description section into shape.
This addresses BZ #595350
https://bugzilla.redhat.com/show_bug.cgi?id=595350
---
This 2nd version of the patch includes the TLS certificate file names
and descriptions irrespective of remote support being enabled, plus
includes all author names.
Additionally, unicode support has been enabled for the generation of
this man page to ensure all author names are displayed correctly.
daemon/Makefile.am | 19 +++++-
daemon/libvirtd.pod.in | 188 ++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 206 insertions(+), 1 deletions(-)
create mode 100644 daemon/libvirtd.pod.in
diff --git a/daemon/Makefile.am b/daemon/Makefile.am
index df34ef1..5401288 100644
--- a/daemon/Makefile.am
+++ b/daemon/Makefile.am
@@ -32,9 +32,12 @@ EXTRA_DIST = \
THREADING.txt \
libvirt-guests.init.in \
libvirt-guests.sysconf \
+ libvirtd.pod.in \
$(AVAHI_SOURCES) \
$(DAEMON_SOURCES)
+man_MANS = libvirtd.8
+
BUILT_SOURCES =
if WITH_LIBVIRTD
@@ -50,6 +53,20 @@ augeas_DATA = libvirtd.aug
augeastestsdir = $(datadir)/augeas/lenses/tests
augeastests_DATA = test_libvirtd.aug
+POD2MAN = pod2man -c "Virtualization Support" \
+ -r "$(PACKAGE)-$(VERSION)" -s 8 -u
+
+libvirtd.pod: libvirtd.pod.in
+ sed \
+ -e 's![@]sysconfdir[@]!$(sysconfdir)!g' \
+ -e 's![@]localstatedir[@]!$(localstatedir)!g' \
+ -e 's![@]remote_pid_file[@]!$(REMOTE_PID_FILE)!g' \
+ < $< > $@-t
+ mv $@-t $@
+
+libvirtd.8: libvirtd.pod
+ $(AM_V_GEN)$(POD2MAN) $< $@
+
libvirtd_SOURCES = $(DAEMON_SOURCES)
#-D_XOPEN_SOURCE=600 -D_XOPEN_SOURCE_EXTENDED=1 -D_POSIX_C_SOURCE=199506L
@@ -285,5 +302,5 @@ uninstall-data-sasl:
endif
-CLEANFILES = $(BUILT_SOURCES)
+CLEANFILES = $(BUILT_SOURCES) $(man_MANS) libvirtd.pod
CLEANFILES += *.cov *.gcov .libs/*.gcda .libs/*.gcno *.gcno *.gcda
diff --git a/daemon/libvirtd.pod.in b/daemon/libvirtd.pod.in
new file mode 100644
index 0000000..f73572c
--- /dev/null
+++ b/daemon/libvirtd.pod.in
@@ -0,0 +1,188 @@
+=encoding utf-8
+
+=head1 NAME
+
+libvirtd - libvirtd management daemon
+
+=head1 SYNOPSIS
+
+B<libvirtd> [ -dlv ] [ -f config_file ] [ -p pid_file ] [ -t timeout_seconds ]
+
+B<libvirtd> --version
+
+=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<-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) expires.
+
+=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
+
+=over
+
+=item F<@sysconfdir(a)/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 when B<run as root>.
+
+=item F<$HOME/.libvirt/libvirt-sock>
+
+The socket libvirtd will use when run as a B<non-root> user.
+
+=item F<@sysconfdir(a)/pki/CA/cacert.pem>
+
+The TLS B<Certificate Authority> certificate libvirtd will use.
+
+=item F<@sysconfdir(a)/pki/libvirt/servercert.pem>
+
+The TLS B<Server> certificate libvirtd will use.
+
+=item F<@sysconfdir(a)/pki/libvirt/private/serverkey.pem>
+
+The TLS B<Server> private key libvirtd will use.
+
+=item F<@remote_pid_file@>
+
+The PID file to use, unless overridden by the B<-p>|B<--pid-file> option.
+
+=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 @remote_pid_file@
+ -rw-r--r-- 1 root root 6 Jul 9 02:40 @remote_pid_file@
+ #
+
+=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
+
+ Stefan Berger <stefanb(a)us.ibm.com>
+ Daniel Berrange <berrange(a)redhat.com>
+ Eric Blake <eblake(a)redhat.com>
+ Matthias Bolte <matthias.bolte(a)googlemail.com>
+ Jiri Denemark <jdenemar(a)redhat.com>
+ Amy Griffis <amy.griffis(a)hp.com>
+ Guido Günther <agx(a)sigxcpu.org>
+ Richard W.M. Jones <rjones(a)redhat.com>
+ Dan Kenigsberg <danken(a)redhat.com>
+ Chris Lalancette <clalance(a)redhat.com>
+ Dave Leskovec <dlesko(a)linux.vnet.ibm.com>
+ John Levon <john.levon(a)sun.com>
+ Wolfgang Mauerer <wolfgang.mauerer(a)siemens.com>
+ Mark McLoughlin <markmc(a)redhat.com>
+ Jim Meyering <meyering(a)redhat.com>
+ Cole Robinson <crobinso(a)redhat.com>
+ Atsushi SAKAI <sakaia(a)jp.fujitsu.com>
+ Laine Stump <laine(a)redhat.com>
+ Miloslav Trmač <mitr(a)redhat.com>
+ Daniel Veillard <veillard(a)redhat.com> or <daniel(a)veillard.com>
+
+=head1 COPYRIGHT
+
+Copyright (C) 2006-2010 Red Hat, Inc. and the above mentioned AUTHORS.
+
+=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-mem(1)>, L<virt-df(1)>, L<http://www.libvirt.org/>
+
+=cut
--
1.7.1
5:45 a.m.
New subject: [libvirt] [PATCHv2] libvirtd: add man page for libvirtd
On 07/09/2010 08:26 PM, Justin Clift wrote:
<snip>
+=head1 AUTHORS
...
+ Guido Günther<agx(a)sigxcpu.org>
...
+ Miloslav Trma�<mitr(a)redhat.com>
Please disregard this patch. It seems to have come through with the
unicode characters garbled.
I'm looking into unicode settings for git send-email now.
Regards and best wishes,
Justin Clift
8:11 a.m.
New subject: [libvirt] [PATCHv2] libvirtd: add man page for libvirtd
On Fri, Jul 09, 2010 at 08:26:31PM +1000, Justin Clift wrote:
With gracious thanks to Chris Lalancette for helping knock the
description section into shape.
This addresses BZ #595350
https://bugzilla.redhat.com/show_bug.cgi?id=595350
---
This 2nd version of the patch includes the TLS certificate file names
and descriptions irrespective of remote support being enabled, plus
includes all author names.
Additionally, unicode support has been enabled for the generation of
this man page to ensure all author names are displayed correctly.
daemon/Makefile.am | 19 +++++-
daemon/libvirtd.pod.in | 188 ++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 206 insertions(+), 1 deletions(-)
create mode 100644 daemon/libvirtd.pod.in
diff --git a/daemon/Makefile.am b/daemon/Makefile.am
index df34ef1..5401288 100644
--- a/daemon/Makefile.am
+++ b/daemon/Makefile.am
@@ -32,9 +32,12 @@ EXTRA_DIST = \
THREADING.txt \
libvirt-guests.init.in \
libvirt-guests.sysconf \
+ libvirtd.pod.in \
$(AVAHI_SOURCES) \
$(DAEMON_SOURCES)
+man_MANS = libvirtd.8
+
BUILT_SOURCES =
if WITH_LIBVIRTD
@@ -50,6 +53,20 @@ augeas_DATA = libvirtd.aug
augeastestsdir = $(datadir)/augeas/lenses/tests
augeastests_DATA = test_libvirtd.aug
+POD2MAN = pod2man -c "Virtualization Support" \
+ -r "$(PACKAGE)-$(VERSION)" -s 8 -u
This breaks the build on at least Fedora 12 due to unknown
-u flag, so I've removed this flag.
Daniel
--
|: Red Hat, Engineering, London -o- http://people.redhat.com/berrange/ :|
|: http://libvirt.org -o- http://virt-manager.org -o- http://deltacloud.org :|
|: http://autobuild.org -o- http://search.cpan.org/~danberr/ :|
|: GnuPG: 7D3B9505 -o- F3C9 553F A1DA 4AC2 5648 23C1 B3DF F742 7D3B 9505 :|
8:16 a.m.
New subject: [libvirt] [PATCHv2] libvirtd: add man page for libvirtd
On 07/12/2010 11:11 PM, Daniel P. Berrange wrote:
<snip>
This breaks the build on at least Fedora 12 due to unknown
-u flag, so I've removed this flag.
Thanks. Working on a workaround now, as it turns out that older
versions of perl can't handle unicode in their .pod pages. :/
Your F12 system may also barf on the "=encoding utf8" bit at the start
of the file too.
Easiest workaround will probably be to just refer people to the AUTHORS
file in the main libvirt package.
It also turns out I need to update the .spec as well. ;)
Regards and best wishes,
Justin Clift
Daniel
2:33 p.m.
New subject: [libvirt] [PATCH] man pages: update authors and copyright notice for libvirtd and virsh
---
This patch removes the individual author names from the libvirtd and virsh
man pages, instead referring to the main AUTHORS file distributed with
libvirt. This approach is needed, as we can't guarantee unicode support
across all versions of pod2man used with libvirt.
Additionally, this patch includes the libvirtd man page in the spec file
used with "make rpm".
daemon/libvirtd.pod.in | 26 +++-----------------------
libvirt.spec.in | 2 ++
tools/virsh.pod | 6 +++---
3 files changed, 8 insertions(+), 26 deletions(-)
diff --git a/daemon/libvirtd.pod.in b/daemon/libvirtd.pod.in
index 9f578c4..45ea71c 100644
--- a/daemon/libvirtd.pod.in
+++ b/daemon/libvirtd.pod.in
@@ -1,5 +1,3 @@
-=encoding utf-8
-
=head1 NAME
libvirtd - libvirtd management daemon
@@ -148,30 +146,12 @@ L<http://libvirt.org/bugs.html>
=head1 AUTHORS
- Stefan Berger <stefanb(a)us.ibm.com>
- Daniel Berrange <berrange(a)redhat.com>
- Eric Blake <eblake(a)redhat.com>
- Matthias Bolte <matthias.bolte(a)googlemail.com>
- Jiri Denemark <jdenemar(a)redhat.com>
- Amy Griffis <amy.griffis(a)hp.com>
- Guido Günther <agx(a)sigxcpu.org>
- Richard W.M. Jones <rjones(a)redhat.com>
- Dan Kenigsberg <danken(a)redhat.com>
- Chris Lalancette <clalance(a)redhat.com>
- Dave Leskovec <dlesko(a)linux.vnet.ibm.com>
- John Levon <john.levon(a)sun.com>
- Wolfgang Mauerer <wolfgang.mauerer(a)siemens.com>
- Mark McLoughlin <markmc(a)redhat.com>
- Jim Meyering <meyering(a)redhat.com>
- Cole Robinson <crobinso(a)redhat.com>
- Atsushi SAKAI <sakaia(a)jp.fujitsu.com>
- Laine Stump <laine(a)redhat.com>
- Miloslav Trmač <mitr(a)redhat.com>
- Daniel Veillard <veillard(a)redhat.com> or <daniel(a)veillard.com>
+Please refer to the AUTHORS file distributed with libvirt.
=head1 COPYRIGHT
-Copyright (C) 2006-2010 Red Hat, Inc. and the above mentioned AUTHORS.
+Copyright (C) 2006-2010 Red Hat, Inc., and the authors listed the libvirt
+AUTHORS file.
=head1 LICENSE
diff --git a/libvirt.spec.in b/libvirt.spec.in
index 33e757c..0944120 100644
--- a/libvirt.spec.in
+++ b/libvirt.spec.in
@@ -828,6 +828,8 @@ fi
%attr(0755, root, root) %{_libexecdir}/libvirt_parthelper
%attr(0755, root, root) %{_sbindir}/libvirtd
+%{_mandir}/man8/libvirtd.8*
+
%doc docs/*.xml
%endif
diff --git a/tools/virsh.pod b/tools/virsh.pod
index e03dbe8..859ebac 100644
--- a/tools/virsh.pod
+++ b/tools/virsh.pod
@@ -1093,8 +1093,7 @@ Alternatively report bugs to your software distributor / vendor.
=head1 AUTHORS
- Andrew Puch <apuch @ redhat.com>
- Daniel Veillard <veillard @ redhat.com>
+ Please refer to the AUTHORS file distributed with libvirt.
Based on the xm man page by:
Sean Dague <sean at dague dot net>
@@ -1102,7 +1101,8 @@ Alternatively report bugs to your software distributor / vendor.
=head1 COPYRIGHT
-Copyright (C) 2005, 2007-2010 Red Hat, Inc.
+Copyright (C) 2005, 2007-2010 Red Hat, Inc., and the authors listed the libvirt
+AUTHORS file.
=head1 LICENSE
--
1.7.1.1
9:40 a.m.
New subject: [libvirt] [PATCHv2] man pages: update authors and copyright notice for libvirtd and virsh
This patch removes the individual author names from the libvirtd and virsh
man pages, instead referring to the main AUTHORS file distributed with
libvirt. This approach is needed, as we can't guarantee unicode support
across all versions of pod2man used with libvirt.
Additionally, this patch includes the libvirtd man page in the spec file
used with "make rpm". Without this patch "make rpm" is broken.
---
This 2nd release fixes a trailing whitespace problem with the 1st version. :/
daemon/libvirtd.pod.in | 26 +++-----------------------
libvirt.spec.in | 2 ++
tools/virsh.pod | 6 +++---
3 files changed, 8 insertions(+), 26 deletions(-)
diff --git a/daemon/libvirtd.pod.in b/daemon/libvirtd.pod.in
index 9f578c4..eb24dc0 100644
--- a/daemon/libvirtd.pod.in
+++ b/daemon/libvirtd.pod.in
@@ -1,5 +1,3 @@
-=encoding utf-8
-
=head1 NAME
libvirtd - libvirtd management daemon
@@ -148,30 +146,12 @@ L<http://libvirt.org/bugs.html>
=head1 AUTHORS
- Stefan Berger <stefanb(a)us.ibm.com>
- Daniel Berrange <berrange(a)redhat.com>
- Eric Blake <eblake(a)redhat.com>
- Matthias Bolte <matthias.bolte(a)googlemail.com>
- Jiri Denemark <jdenemar(a)redhat.com>
- Amy Griffis <amy.griffis(a)hp.com>
- Guido Günther <agx(a)sigxcpu.org>
- Richard W.M. Jones <rjones(a)redhat.com>
- Dan Kenigsberg <danken(a)redhat.com>
- Chris Lalancette <clalance(a)redhat.com>
- Dave Leskovec <dlesko(a)linux.vnet.ibm.com>
- John Levon <john.levon(a)sun.com>
- Wolfgang Mauerer <wolfgang.mauerer(a)siemens.com>
- Mark McLoughlin <markmc(a)redhat.com>
- Jim Meyering <meyering(a)redhat.com>
- Cole Robinson <crobinso(a)redhat.com>
- Atsushi SAKAI <sakaia(a)jp.fujitsu.com>
- Laine Stump <laine(a)redhat.com>
- Miloslav Trmač <mitr(a)redhat.com>
- Daniel Veillard <veillard(a)redhat.com> or <daniel(a)veillard.com>
+Please refer to the AUTHORS file distributed with libvirt.
=head1 COPYRIGHT
-Copyright (C) 2006-2010 Red Hat, Inc. and the above mentioned AUTHORS.
+Copyright (C) 2006-2010 Red Hat, Inc., and the authors listed the libvirt
+AUTHORS file.
=head1 LICENSE
diff --git a/libvirt.spec.in b/libvirt.spec.in
index ce58f2a..6d3c3c2 100644
--- a/libvirt.spec.in
+++ b/libvirt.spec.in
@@ -828,6 +828,8 @@ fi
%attr(0755, root, root) %{_libexecdir}/libvirt_parthelper
%attr(0755, root, root) %{_sbindir}/libvirtd
+%{_mandir}/man8/libvirtd.8*
+
%doc docs/*.xml
%endif
diff --git a/tools/virsh.pod b/tools/virsh.pod
index e03dbe8..5740068 100644
--- a/tools/virsh.pod
+++ b/tools/virsh.pod
@@ -1093,8 +1093,7 @@ Alternatively report bugs to your software distributor / vendor.
=head1 AUTHORS
- Andrew Puch <apuch @ redhat.com>
- Daniel Veillard <veillard @ redhat.com>
+ Please refer to the AUTHORS file distributed with libvirt.
Based on the xm man page by:
Sean Dague <sean at dague dot net>
@@ -1102,7 +1101,8 @@ Alternatively report bugs to your software distributor / vendor.
=head1 COPYRIGHT
-Copyright (C) 2005, 2007-2010 Red Hat, Inc.
+Copyright (C) 2005, 2007-2010 Red Hat, Inc., and the authors listed the libvirt
+AUTHORS file.
=head1 LICENSE
--
1.7.1.1
1:14 p.m.
New subject: [libvirt] [PATCHv2] man pages: update authors and copyright notice for libvirtd and virsh
On 07/16/2010 10:40 AM, Justin Clift wrote:
This patch removes the individual author names from the libvirtd and
virsh
man pages, instead referring to the main AUTHORS file distributed with
libvirt. This approach is needed, as we can't guarantee unicode support
across all versions of pod2man used with libvirt.
Additionally, this patch includes the libvirtd man page in the spec file
used with "make rpm". Without this patch "make rpm" is broken.
---
This 2nd release fixes a trailing whitespace problem with the 1st version. :/
daemon/libvirtd.pod.in | 26 +++-----------------------
libvirt.spec.in | 2 ++
tools/virsh.pod | 6 +++---
3 files changed, 8 insertions(+), 26 deletions(-)
diff --git a/daemon/libvirtd.pod.in b/daemon/libvirtd.pod.in
index 9f578c4..eb24dc0 100644
--- a/daemon/libvirtd.pod.in
+++ b/daemon/libvirtd.pod.in
@@ -1,5 +1,3 @@
-=encoding utf-8
-
=head1 NAME
libvirtd - libvirtd management daemon
@@ -148,30 +146,12 @@ L<http://libvirt.org/bugs.html>
=head1 AUTHORS
- Stefan Berger<stefanb(a)us.ibm.com>
- Daniel Berrange<berrange(a)redhat.com>
- Eric Blake<eblake(a)redhat.com>
- Matthias Bolte<matthias.bolte(a)googlemail.com>
- Jiri Denemark<jdenemar(a)redhat.com>
- Amy Griffis<amy.griffis(a)hp.com>
- Guido Günther<agx(a)sigxcpu.org>
- Richard W.M. Jones<rjones(a)redhat.com>
- Dan Kenigsberg<danken(a)redhat.com>
- Chris Lalancette<clalance(a)redhat.com>
- Dave Leskovec<dlesko(a)linux.vnet.ibm.com>
- John Levon<john.levon(a)sun.com>
- Wolfgang Mauerer<wolfgang.mauerer(a)siemens.com>
- Mark McLoughlin<markmc(a)redhat.com>
- Jim Meyering<meyering(a)redhat.com>
- Cole Robinson<crobinso(a)redhat.com>
- Atsushi SAKAI<sakaia(a)jp.fujitsu.com>
- Laine Stump<laine(a)redhat.com>
- Miloslav Trmač<mitr(a)redhat.com>
- Daniel Veillard<veillard(a)redhat.com> or<daniel(a)veillard.com>
+Please refer to the AUTHORS file distributed with libvirt.
=head1 COPYRIGHT
-Copyright (C) 2006-2010 Red Hat, Inc. and the above mentioned AUTHORS.
+Copyright (C) 2006-2010 Red Hat, Inc., and the authors listed the libvirt
+AUTHORS file.
listed *in* the libvirt AUTHORS file.
=head1 LICENSE
diff --git a/libvirt.spec.in b/libvirt.spec.in
index ce58f2a..6d3c3c2 100644
--- a/libvirt.spec.in
+++ b/libvirt.spec.in
@@ -828,6 +828,8 @@ fi
%attr(0755, root, root) %{_libexecdir}/libvirt_parthelper
%attr(0755, root, root) %{_sbindir}/libvirtd
+%{_mandir}/man8/libvirtd.8*
+
%doc docs/*.xml
%endif
diff --git a/tools/virsh.pod b/tools/virsh.pod
index e03dbe8..5740068 100644
--- a/tools/virsh.pod
+++ b/tools/virsh.pod
@@ -1093,8 +1093,7 @@ Alternatively report bugs to your software distributor / vendor.
=head1 AUTHORS
- Andrew Puch<apuch @ redhat.com>
- Daniel Veillard<veillard @ redhat.com>
+ Please refer to the AUTHORS file distributed with libvirt.
Based on the xm man page by:
Sean Dague<sean at dague dot net>
@@ -1102,7 +1101,8 @@ Alternatively report bugs to your software distributor / vendor.
=head1 COPYRIGHT
-Copyright (C) 2005, 2007-2010 Red Hat, Inc.
+Copyright (C) 2005, 2007-2010 Red Hat, Inc., and the authors listed the libvirt
+AUTHORS file.
=head1 LICENSE
2:07 p.m.
New subject: [libvirt] [PATCHv3] man pages: update authors and copyright notice for libvirtd and virsh
This patch removes the individual author names from the libvirtd and virsh
man pages, instead referring to the main AUTHORS file distributed with
libvirt. This approach is needed, as we can't guarantee unicode support
across all versions of pod2man used with libvirt.
Additionally, this patch includes the libvirtd man page in the spec file
used with "make rpm". Without this patch "make rpm" is broken.
---
Typo fix. :)
daemon/libvirtd.pod.in | 26 +++-----------------------
libvirt.spec.in | 2 ++
tools/virsh.pod | 6 +++---
3 files changed, 8 insertions(+), 26 deletions(-)
diff --git a/daemon/libvirtd.pod.in b/daemon/libvirtd.pod.in
index 9f578c4..eb24dc0 100644
--- a/daemon/libvirtd.pod.in
+++ b/daemon/libvirtd.pod.in
@@ -1,5 +1,3 @@
-=encoding utf-8
-
=head1 NAME
libvirtd - libvirtd management daemon
@@ -148,30 +146,12 @@ L<http://libvirt.org/bugs.html>
=head1 AUTHORS
- Stefan Berger <stefanb(a)us.ibm.com>
- Daniel Berrange <berrange(a)redhat.com>
- Eric Blake <eblake(a)redhat.com>
- Matthias Bolte <matthias.bolte(a)googlemail.com>
- Jiri Denemark <jdenemar(a)redhat.com>
- Amy Griffis <amy.griffis(a)hp.com>
- Guido Günther <agx(a)sigxcpu.org>
- Richard W.M. Jones <rjones(a)redhat.com>
- Dan Kenigsberg <danken(a)redhat.com>
- Chris Lalancette <clalance(a)redhat.com>
- Dave Leskovec <dlesko(a)linux.vnet.ibm.com>
- John Levon <john.levon(a)sun.com>
- Wolfgang Mauerer <wolfgang.mauerer(a)siemens.com>
- Mark McLoughlin <markmc(a)redhat.com>
- Jim Meyering <meyering(a)redhat.com>
- Cole Robinson <crobinso(a)redhat.com>
- Atsushi SAKAI <sakaia(a)jp.fujitsu.com>
- Laine Stump <laine(a)redhat.com>
- Miloslav Trmač <mitr(a)redhat.com>
- Daniel Veillard <veillard(a)redhat.com> or <daniel(a)veillard.com>
+Please refer to the AUTHORS file distributed with libvirt.
=head1 COPYRIGHT
-Copyright (C) 2006-2010 Red Hat, Inc. and the above mentioned AUTHORS.
+Copyright (C) 2006-2010 Red Hat, Inc., and the authors listed in the
+libvirt AUTHORS file.
=head1 LICENSE
diff --git a/libvirt.spec.in b/libvirt.spec.in
index ce58f2a..6d3c3c2 100644
--- a/libvirt.spec.in
+++ b/libvirt.spec.in
@@ -828,6 +828,8 @@ fi
%attr(0755, root, root) %{_libexecdir}/libvirt_parthelper
%attr(0755, root, root) %{_sbindir}/libvirtd
+%{_mandir}/man8/libvirtd.8*
+
%doc docs/*.xml
%endif
diff --git a/tools/virsh.pod b/tools/virsh.pod
index e03dbe8..5740068 100644
--- a/tools/virsh.pod
+++ b/tools/virsh.pod
@@ -1093,8 +1093,7 @@ Alternatively report bugs to your software distributor / vendor.
=head1 AUTHORS
- Andrew Puch <apuch @ redhat.com>
- Daniel Veillard <veillard @ redhat.com>
+ Please refer to the AUTHORS file distributed with libvirt.
Based on the xm man page by:
Sean Dague <sean at dague dot net>
@@ -1102,7 +1101,8 @@ Alternatively report bugs to your software distributor / vendor.
=head1 COPYRIGHT
-Copyright (C) 2005, 2007-2010 Red Hat, Inc.
+Copyright (C) 2005, 2007-2010 Red Hat, Inc., and the authors listed in the
+libvirt AUTHORS file.
=head1 LICENSE
--
1.7.1.1
3:23 p.m.
New subject: [libvirt] [PATCHv3] man pages: update authors and copyright notice for libvirtd and virsh
On 07/16/2010 03:07 PM, Justin Clift wrote:
This patch removes the individual author names from the libvirtd and
virsh
man pages, instead referring to the main AUTHORS file distributed with
libvirt. This approach is needed, as we can't guarantee unicode support
across all versions of pod2man used with libvirt.
Additionally, this patch includes the libvirtd man page in the spec file
used with "make rpm". Without this patch "make rpm" is broken.
ACK.
11:33 p.m.
New subject: [libvirt] [PATCHv3] man pages: update authors and copyright notice for libvirtd and virsh
On 07/17/2010 06:23 AM, Laine Stump wrote:
On 07/16/2010 03:07 PM, Justin Clift wrote:
> This patch removes the individual author names from the libvirtd and
> virsh
> man pages, instead referring to the main AUTHORS file distributed with
> libvirt. This approach is needed, as we can't guarantee unicode support
> across all versions of pod2man used with libvirt.
>
> Additionally, this patch includes the libvirtd man page in the spec file
> used with "make rpm". Without this patch "make rpm" is broken.
>
ACK.
Thanks Laine, pushed. :)
Regards and best wishes,
Justin Clift
5:58 a.m.
New subject: [libvirt] [PATCHv3] libvirtd: add man page for libvirtd
With gracious thanks to Chris Lalancette for helping knock the
description section into shape.
This addresses BZ #595350
https://bugzilla.redhat.com/show_bug.cgi?id=595350
---
This 3rd version of the patch includes the TLS certificate file names
and descriptions irrespective of remote support being enabled, plus
includes all author names.
Additionally, unicode support has been enabled for the generation of
this man page and for sending of this patch via git send-email, ensuring
all author names are displayed correctly.
daemon/Makefile.am | 19 +++++-
daemon/libvirtd.pod.in | 188 ++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 206 insertions(+), 1 deletions(-)
create mode 100644 daemon/libvirtd.pod.in
diff --git a/daemon/Makefile.am b/daemon/Makefile.am
index df34ef1..5401288 100644
--- a/daemon/Makefile.am
+++ b/daemon/Makefile.am
@@ -32,9 +32,12 @@ EXTRA_DIST = \
THREADING.txt \
libvirt-guests.init.in \
libvirt-guests.sysconf \
+ libvirtd.pod.in \
$(AVAHI_SOURCES) \
$(DAEMON_SOURCES)
+man_MANS = libvirtd.8
+
BUILT_SOURCES =
if WITH_LIBVIRTD
@@ -50,6 +53,20 @@ augeas_DATA = libvirtd.aug
augeastestsdir = $(datadir)/augeas/lenses/tests
augeastests_DATA = test_libvirtd.aug
+POD2MAN = pod2man -c "Virtualization Support" \
+ -r "$(PACKAGE)-$(VERSION)" -s 8 -u
+
+libvirtd.pod: libvirtd.pod.in
+ sed \
+ -e 's![@]sysconfdir[@]!$(sysconfdir)!g' \
+ -e 's![@]localstatedir[@]!$(localstatedir)!g' \
+ -e 's![@]remote_pid_file[@]!$(REMOTE_PID_FILE)!g' \
+ < $< > $@-t
+ mv $@-t $@
+
+libvirtd.8: libvirtd.pod
+ $(AM_V_GEN)$(POD2MAN) $< $@
+
libvirtd_SOURCES = $(DAEMON_SOURCES)
#-D_XOPEN_SOURCE=600 -D_XOPEN_SOURCE_EXTENDED=1 -D_POSIX_C_SOURCE=199506L
@@ -285,5 +302,5 @@ uninstall-data-sasl:
endif
-CLEANFILES = $(BUILT_SOURCES)
+CLEANFILES = $(BUILT_SOURCES) $(man_MANS) libvirtd.pod
CLEANFILES += *.cov *.gcov .libs/*.gcda .libs/*.gcno *.gcno *.gcda
diff --git a/daemon/libvirtd.pod.in b/daemon/libvirtd.pod.in
new file mode 100644
index 0000000..f73572c
--- /dev/null
+++ b/daemon/libvirtd.pod.in
@@ -0,0 +1,188 @@
+=encoding utf-8
+
+=head1 NAME
+
+libvirtd - libvirtd management daemon
+
+=head1 SYNOPSIS
+
+B<libvirtd> [ -dlv ] [ -f config_file ] [ -p pid_file ] [ -t timeout_seconds ]
+
+B<libvirtd> --version
+
+=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<-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) expires.
+
+=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
+
+=over
+
+=item F<@sysconfdir(a)/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 when B<run as root>.
+
+=item F<$HOME/.libvirt/libvirt-sock>
+
+The socket libvirtd will use when run as a B<non-root> user.
+
+=item F<@sysconfdir(a)/pki/CA/cacert.pem>
+
+The TLS B<Certificate Authority> certificate libvirtd will use.
+
+=item F<@sysconfdir(a)/pki/libvirt/servercert.pem>
+
+The TLS B<Server> certificate libvirtd will use.
+
+=item F<@sysconfdir(a)/pki/libvirt/private/serverkey.pem>
+
+The TLS B<Server> private key libvirtd will use.
+
+=item F<@remote_pid_file@>
+
+The PID file to use, unless overridden by the B<-p>|B<--pid-file> option.
+
+=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 @remote_pid_file@
+ -rw-r--r-- 1 root root 6 Jul 9 02:40 @remote_pid_file@
+ #
+
+=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
+
+ Stefan Berger <stefanb(a)us.ibm.com>
+ Daniel Berrange <berrange(a)redhat.com>
+ Eric Blake <eblake(a)redhat.com>
+ Matthias Bolte <matthias.bolte(a)googlemail.com>
+ Jiri Denemark <jdenemar(a)redhat.com>
+ Amy Griffis <amy.griffis(a)hp.com>
+ Guido Günther <agx(a)sigxcpu.org>
+ Richard W.M. Jones <rjones(a)redhat.com>
+ Dan Kenigsberg <danken(a)redhat.com>
+ Chris Lalancette <clalance(a)redhat.com>
+ Dave Leskovec <dlesko(a)linux.vnet.ibm.com>
+ John Levon <john.levon(a)sun.com>
+ Wolfgang Mauerer <wolfgang.mauerer(a)siemens.com>
+ Mark McLoughlin <markmc(a)redhat.com>
+ Jim Meyering <meyering(a)redhat.com>
+ Cole Robinson <crobinso(a)redhat.com>
+ Atsushi SAKAI <sakaia(a)jp.fujitsu.com>
+ Laine Stump <laine(a)redhat.com>
+ Miloslav Trmač <mitr(a)redhat.com>
+ Daniel Veillard <veillard(a)redhat.com> or <daniel(a)veillard.com>
+
+=head1 COPYRIGHT
+
+Copyright (C) 2006-2010 Red Hat, Inc. and the above mentioned AUTHORS.
+
+=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-mem(1)>, L<virt-df(1)>, L<http://www.libvirt.org/>
+
+=cut
--
1.7.1
8:58 a.m.
New subject: [libvirt] [PATCHv3] libvirtd: add man page for libvirtd
On 07/09/10 - 08:58:58PM, Justin Clift wrote:
With gracious thanks to Chris Lalancette for helping knock the
description section into shape.
This addresses BZ #595350
https://bugzilla.redhat.com/show_bug.cgi?id=595350
Yeah, this looks pretty good now. Any further refinements can be done
as patches to this.
ACK
--
Chris Lalancette
9:38 a.m.
New subject: [libvirt] [PATCHv3] libvirtd: add man page for libvirtd
On 07/09/2010 11:58 PM, Chris Lalancette wrote:
On 07/09/10 - 08:58:58PM, Justin Clift wrote:
> With gracious thanks to Chris Lalancette for helping knock the
> description section into shape.
>
> This addresses BZ #595350
>
> https://bugzilla.redhat.com/show_bug.cgi?id=595350
Yeah, this looks pretty good now. Any further refinements can be done
as patches to this.
ACK
Thanks, pushed.
Regards and best wishes,
Justin Clift
5246
days inactive
5255
days old
17 comments
4 participants
participants (4)
-
Chris Lalancette -
Daniel P. Berrange -
Justin Clift -
Laine Stump