source: archive/libvirt.xml

trunk
Last change on this file was 45ab6c7, checked in by Xi Ruoyao <xry111@…>, 3 months ago

more SVN prop clean up

Remove "$LastChanged$" everywhere, and also some unused $Date$

  • Property mode set to 100644
File size: 8.5 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY libvirt-download-http "http://libvirt.org/sources/libvirt-&libvirt-version;.tar.gz">
8 <!ENTITY libvirt-download-ftp " ">
9 <!ENTITY libvirt-md5sum "5e842bc55733ceba60c64767580ff3e4">
10 <!ENTITY libvirt-size "19 MB">
11 <!ENTITY libvirt-buildsize "240 MB">
12 <!ENTITY libvirt-time "1.6 SBU">
13]>
14
15<sect1 id="libvirt" xreflabel="libvirt-&libvirt-version;">
16 <?dbhtml filename="libvirt.html"?>
17
18 <sect1info>
19 <date>$Date$</date>
20 </sect1info>
21
22 <title>libvirt-&libvirt-version;</title>
23
24 <indexterm zone="libvirt">
25 <primary sortas="a-libvirt">libvirt</primary>
26 </indexterm>
27
28 <sect2 role="package">
29 <title>Introduction to libvirt</title>
30
31 <para>
32 The <application>libvirt</application> is a C toolkit
33 used to interact with the virtualization capabilities
34 of recent versions of Linux (and other OSes).
35 </para>
36
37 &lfs71_checked;
38
39 <bridgehead renderas="sect3">Package Information</bridgehead>
40 <itemizedlist spacing="compact">
41 <listitem>
42 <para>
43 Download (HTTP): <ulink url="&libvirt-download-http;"/>
44 </para>
45 </listitem>
46 <listitem>
47 <para>
48 Download (FTP): <ulink url="&libvirt-download-ftp;"/>
49 </para>
50 </listitem>
51 <listitem>
52 <para>
53 Download MD5 sum: &libvirt-md5sum;
54 </para>
55 </listitem>
56 <listitem>
57 <para>
58 Download size: &libvirt-size;
59 </para>
60 </listitem>
61 <listitem>
62 <para>
63 Estimated disk space required: &libvirt-buildsize;
64 </para>
65 </listitem>
66 <listitem>
67 <para>
68 Estimated build time: &libvirt-time;
69 </para>
70 </listitem>
71 </itemizedlist>
72
73 <bridgehead renderas="sect3">libvirt Dependencies</bridgehead>
74
75 <bridgehead renderas="sect4">Required</bridgehead>
76 <para role="required">
77 <xref linkend="gnutls"/>,
78 <xref linkend="libgcrypt"/>,
79 <xref linkend="libtirpc"/>,
80 <xref linkend="libxml2"/> and
81 <xref linkend="lvm2"/>
82 </para>
83
84 <bridgehead renderas="sect4">Recommended</bridgehead>
85 <para role="recommended">
86 <xref linkend="polkit"/>
87 </para>
88
89 <bridgehead renderas="sect4">Optional</bridgehead>
90 <para role="optional">
91 <xref linkend="avahi"/>,
92 <xref linkend="curl"/>,
93 <xref linkend="cyrus-sasl"/>,
94 <ulink url="http://people.redhat.com/sgrubb/libcap-ng/">
95 libcap-ng</ulink>,
96 <xref linkend="libnl"/>,
97 <ulink url="http://oss.sgi.com/projects/libnuma/">
98 libnuma</ulink>,
99 <xref linkend="libpcap"/>,
100 <ulink url="http://www.libssh2.org/">libssh2</ulink>,
101 <ulink url="https://fedorahosted.org/netcf/">NetCF</ulink>,
102 <ulink url="http://www.open-iscsi.org/">Open iSCSI</ulink>,
103 <ulink url="http://www.openswan.org/projects/openswan/">
104 OpenSwan</ulink>,
105 <xref linkend="parted"/>,
106 <xref linkend="qemu-kvm"/>,
107 <ulink url="https://www.virtualbox.org/">VirtualBox</ulink>,
108 <ulink url="http://www.xen.org/">Xen</ulink>,
109 <xref linkend="xorg7-lib"/> and
110 <ulink url="http://lloyd.github.com/yajl/">YAYL</ulink>
111 </para>
112
113 <para condition="html" role="usernotes">
114 User Notes: <ulink url="&blfs-wiki;/libvirt"/>
115 </para>
116 </sect2>
117
118 <sect2 role="installation">
119 <title>Installation of libvirt</title>
120
121 <para>
122 Install <application>libvirt</application> by running the following
123 commands:
124 </para>
125
126<screen><userinput>./configure --prefix=/usr \
127 --libexecdir=/usr/lib/libvirt \
128 --with-storage-lvm \
129 --without-macvtap \
130 --disable-static \
131 CPPFLAGS="-I/usr/include/tirpc -I/usr/include/libnl3" &amp;&amp;
132make</userinput></screen>
133
134 <para>
135 To test the results, issue: <command>make check</command>.
136 </para>
137
138 <para>
139 Now, as the <systemitem class="username">root</systemitem> user:
140 </para>
141
142<screen role="root"><userinput>make install</userinput></screen>
143 </sect2>
144
145 <sect2 role="commands">
146 <title>Command Explanations</title>
147
148 <para>
149 <option>--with-storage-lvm</option>: This option enables LVM storage backend.
150 </para>
151
152 <para>
153 <option>--without-macvtap</option>: This option disables macvtap device support.
154 Remove if you have installed <xref linkend="libnl"/>.
155 </para>
156
157 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
158 href="../../xincludes/static-libraries.xml"/>
159
160 </sect2>
161
162 <sect2 role="content">
163 <title>Contents</title>
164
165 <segmentedlist>
166 <segtitle>Installed Programs</segtitle>
167 <segtitle>Installed Libraries</segtitle>
168 <segtitle>Installed Directories</segtitle>
169
170 <seglistitem>
171 <seg>
172 libvirtd, virsh, virt-host-validate,
173 virt-pki-validate and virt-xml-validate
174 </seg>
175 <seg>
176 libvirt.so and libvirt-qemu.so
177 </seg>
178 <seg>
179 /etc/libvirt, /usr/include/libvirt, /usr/lib/libvirt,
180 /usr/share/augeas/lenses,
181 /usr/share/doc/{libvirt-0.9.11,libvirt-python-0.9.11},
182 /usr/share/gtk-doc/html/libvirt,
183 /usr/share/libvirt, /var/cache/libvirt, /var/lib/libvirt and
184 /var/log/libvirt
185 </seg>
186 </seglistitem>
187 </segmentedlist>
188
189 <variablelist>
190 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
191 <?dbfo list-presentation="list"?>
192 <?dbhtml list-presentation="table"?>
193
194 <!-- If the program or library name conflicts (is the same) as the
195 package name, add -prog or -lib to the varlistentry entity id
196 and the 2nd entry of the indexterm zone entity -->
197
198 <varlistentry id="libvirtd">
199 <term><command>libvirtd</command></term>
200 <listitem>
201 <para>
202 is the server side daemon component of the libvirt
203 virtualization management system.
204 </para>
205 <indexterm zone="libvirt libvirtd">
206 <primary sortas="b-libvirtd">libvirtd</primary>
207 </indexterm>
208 </listitem>
209 </varlistentry>
210
211 <varlistentry id="virsh">
212 <term><command>virsh</command></term>
213 <listitem>
214 <para>
215 is the main interface for managing virsh guest domains.
216 </para>
217 <indexterm zone="libvirt virsh">
218 <primary sortas="b-virsh">virsh</primary>
219 </indexterm>
220 </listitem>
221 </varlistentry>
222
223 <varlistentry id="virt-host-validate">
224 <term><command>virt-host-validate</command></term>
225 <listitem>
226 <para>
227 This tool validates that the host is configured in
228 a suitable way to run libvirt hypervisor drivers.
229 </para>
230 <indexterm zone="libvirt virt-host-validate">
231 <primary sortas="b-virt-host-validate">virt-host-validate</primary>
232 </indexterm>
233 </listitem>
234 </varlistentry>
235
236 <varlistentry id="virt-pki-validate">
237 <term><command>virt-pki-validate</command></term>
238 <listitem>
239 <para>
240 This tool validates that the necessary PKI files are
241 configured for a secure libvirt server or client
242 using the TLS encryption protocol.
243 </para>
244 <indexterm zone="libvirt virt-pki-validate">
245 <primary sortas="b-virt-pki-validate">virt-pki-validate</primary>
246 </indexterm>
247 </listitem>
248 </varlistentry>
249
250 <varlistentry id="virt-xml-validate">
251 <term><command>virt-xml-validate</command></term>
252 <listitem>
253 <para>
254 is used to validate a libvirt XML for compliance with the
255 published schema.
256 </para>
257 <indexterm zone="libvirt virt-xml-validate">
258 <primary sortas="b-virt-xml-validate">virt-xml-validate</primary>
259 </indexterm>
260 </listitem>
261 </varlistentry>
262
263 <varlistentry id="libvirt-lib">
264 <term><filename class="libraryfile">libvirt.so</filename></term>
265 <listitem>
266 <para>
267 contains the <application>libvirt</application> API functions.
268 </para>
269 <indexterm zone="libvirt libvirt-lib">
270 <primary sortas="c-libvirt">libvirt.so</primary>
271 </indexterm>
272 </listitem>
273 </varlistentry>
274
275 </variablelist>
276
277 </sect2>
278
279</sect1>
Note: See TracBrowser for help on using the repository browser.