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 libical-download-http "https://github.com/libical/libical/releases/download/v&libical-version;/libical-&libical-version;.tar.gz">
|
---|
8 | <!--
|
---|
9 | <!ENTITY libical-download-http "https://github.com/libical/libical/archive/v&libical-version;.tar.gz">-->
|
---|
10 | <!ENTITY libical-download-ftp " ">
|
---|
11 | <!ENTITY libical-md5sum "6bf8e5f5a3ba88baf390d0134e05d76e">
|
---|
12 | <!ENTITY libical-size "684 KB">
|
---|
13 | <!ENTITY libical-buildsize "14 MB, with tests (additional 12 MB for the API documentation)">
|
---|
14 | <!ENTITY libical-time "0.3 SBU, (with tests and API documentation)">
|
---|
15 | ]>
|
---|
16 |
|
---|
17 | <sect1 id="libical" xreflabel="libical-&libical-version;">
|
---|
18 | <?dbhtml filename="libical.html"?>
|
---|
19 |
|
---|
20 | <sect1info>
|
---|
21 | <othername>$LastChangedBy$</othername>
|
---|
22 | <date>$Date$</date>
|
---|
23 | </sect1info>
|
---|
24 |
|
---|
25 | <title>libical-&libical-version;</title>
|
---|
26 |
|
---|
27 | <indexterm zone="libical">
|
---|
28 | <primary sortas="a-libical">libical</primary>
|
---|
29 | </indexterm>
|
---|
30 |
|
---|
31 | <sect2 role="package">
|
---|
32 | <title>Introduction to libical</title>
|
---|
33 |
|
---|
34 | <para>
|
---|
35 | The <application>libical</application> package contains an implementation
|
---|
36 | of the iCalendar protocols and data formats.
|
---|
37 | </para>
|
---|
38 |
|
---|
39 | &lfs78_checked;
|
---|
40 |
|
---|
41 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
42 | <!--
|
---|
43 | <note>
|
---|
44 |
|
---|
45 | <para>The download link below obtains
|
---|
46 | <filename>libical-&libical-version;.tar.gz</filename> if a web browser
|
---|
47 | such as <xref linkend="firefox"/> is used. This is the correct name
|
---|
48 | for the archive, because it saves the file as <filename
|
---|
49 | class="directory">libical-&libical-version;</filename>. However, if
|
---|
50 | another method is used for downloading, e.g. <xref linkend="wget"/>, the
|
---|
51 | file name is <filename>v&libical-version;.tar.gz</filename>, which is not
|
---|
52 | acceptable. The file should be renamed to the correct filename
|
---|
53 | <filename>libical-&libical-version;.tar.gz</filename>. You can achieve
|
---|
54 | this automatically by using the command:</para>
|
---|
55 |
|
---|
56 | <screen><userinput>wget <ulink url="&libical-download-http;"/> -O libical-&libical-version;.tar.gz</userinput></screen>
|
---|
57 | </note>
|
---|
58 | -->
|
---|
59 | <itemizedlist spacing="compact">
|
---|
60 | <listitem>
|
---|
61 | <para>
|
---|
62 | Download (HTTP): <ulink url="&libical-download-http;"/>
|
---|
63 | </para>
|
---|
64 | </listitem>
|
---|
65 | <listitem>
|
---|
66 | <para>
|
---|
67 | Download (FTP): <ulink url="&libical-download-ftp;"/>
|
---|
68 | </para>
|
---|
69 | </listitem>
|
---|
70 | <listitem>
|
---|
71 | <para>
|
---|
72 | Download MD5 sum: &libical-md5sum;
|
---|
73 | </para>
|
---|
74 | </listitem>
|
---|
75 | <listitem>
|
---|
76 | <para>
|
---|
77 | Download size: &libical-size;
|
---|
78 | </para>
|
---|
79 | </listitem>
|
---|
80 | <listitem>
|
---|
81 | <para>
|
---|
82 | Estimated disk space required: &libical-buildsize;
|
---|
83 | </para>
|
---|
84 | </listitem>
|
---|
85 | <listitem>
|
---|
86 | <para>
|
---|
87 | Estimated build time: &libical-time;
|
---|
88 | </para>
|
---|
89 | </listitem>
|
---|
90 | </itemizedlist>
|
---|
91 |
|
---|
92 | <bridgehead renderas="sect3">libical Dependencies</bridgehead>
|
---|
93 |
|
---|
94 | <!-- Upstream recommends to use CMake since autotools
|
---|
95 | doesn't bump soname for 0.48 -> 1.0 incompatibility -->
|
---|
96 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
97 | <para role="required">
|
---|
98 | <xref linkend="cmake"/>
|
---|
99 | </para>
|
---|
100 |
|
---|
101 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
102 | <para role="optional">
|
---|
103 | <xref linkend="db"/>,
|
---|
104 | <xref linkend="doxygen"/> (for the API documentation),
|
---|
105 | <xref linkend="gobject-introspection"/>, and
|
---|
106 | <xref linkend="icu"/>
|
---|
107 | </para>
|
---|
108 |
|
---|
109 | <!-- Can't be built using CMake
|
---|
110 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
111 | <para role="optional">
|
---|
112 | <xref linkend="openjdk"/> and
|
---|
113 | <xref linkend="python2"/> (must have <xref linkend="swig"/> also)
|
---|
114 | </para> -->
|
---|
115 |
|
---|
116 | <para condition="html" role="usernotes">User Notes:
|
---|
117 | <ulink url="&blfs-wiki;/libical"/>
|
---|
118 | </para>
|
---|
119 | </sect2>
|
---|
120 |
|
---|
121 | <sect2 role="installation">
|
---|
122 | <title>Installation of libical</title>
|
---|
123 |
|
---|
124 | <para>
|
---|
125 | Install <application>libical</application> by running the
|
---|
126 | following commands:
|
---|
127 | </para>
|
---|
128 |
|
---|
129 | <screen><userinput>mkdir build &&
|
---|
130 | cd build &&
|
---|
131 |
|
---|
132 | cmake -DCMAKE_INSTALL_PREFIX=/usr \
|
---|
133 | -DCMAKE_BUILD_TYPE=Release \
|
---|
134 | -DSHARED_ONLY=yes \
|
---|
135 | .. &&
|
---|
136 | make</userinput></screen>
|
---|
137 |
|
---|
138 | <para>
|
---|
139 | If you have <xref linkend="doxygen"/> installed and wish to build the API
|
---|
140 | documentation, issue:
|
---|
141 | </para>
|
---|
142 |
|
---|
143 | <screen><userinput>make docs</userinput></screen>
|
---|
144 |
|
---|
145 | <para>
|
---|
146 | To test the results, issue: <command>make test</command>.
|
---|
147 | </para>
|
---|
148 |
|
---|
149 | <para>
|
---|
150 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
151 | </para>
|
---|
152 |
|
---|
153 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
154 |
|
---|
155 | <para>
|
---|
156 | If you have built the API documentation, install by issuing, as
|
---|
157 | <systemitem class="username">root</systemitem> user:
|
---|
158 | </para>
|
---|
159 |
|
---|
160 | <screen role="root"><userinput>install -vdm755 /usr/share/doc/libical-&libical-version;/html &&
|
---|
161 | cp -vr apidocs/html/* /usr/share/doc/libical-&libical-version;/html</userinput></screen>
|
---|
162 |
|
---|
163 | </sect2>
|
---|
164 |
|
---|
165 | <sect2 role="commands">
|
---|
166 | <title>Command Explanations</title>
|
---|
167 |
|
---|
168 | <para>
|
---|
169 | <parameter>-DCMAKE_BUILD_TYPE=Release</parameter>: This switch is used
|
---|
170 | to apply higher level of the compiler optimizations.
|
---|
171 | </para>
|
---|
172 |
|
---|
173 | <para>
|
---|
174 | <parameter>-DSHARED_ONLY=yes</parameter>: This switch is used
|
---|
175 | in order to only build the shared libraries.
|
---|
176 | </para>
|
---|
177 |
|
---|
178 | <para>
|
---|
179 | <option>-DUSE_BUILTIN_TZDATA=yes</option>: This switch is used
|
---|
180 | in order to build using your own timezone data.
|
---|
181 | </para>
|
---|
182 |
|
---|
183 | <!-- No CMake equivalents
|
---|
184 | <para>
|
---|
185 | <parameter>- -enable-cxx</parameter>: This switch enables
|
---|
186 | <application>libical</application> C++ library.
|
---|
187 | </para>
|
---|
188 |
|
---|
189 | <para>
|
---|
190 | <option>- -enable-python</option>: This switch enables
|
---|
191 | <application>libical</application> Python bindings.
|
---|
192 | </para> -->
|
---|
193 |
|
---|
194 | </sect2>
|
---|
195 |
|
---|
196 | <sect2 role="content">
|
---|
197 | <title>Contents</title>
|
---|
198 |
|
---|
199 | <segmentedlist>
|
---|
200 | <segtitle>Installed Programs</segtitle>
|
---|
201 | <segtitle>Installed Libraries</segtitle>
|
---|
202 | <segtitle>Installed Directory</segtitle>
|
---|
203 |
|
---|
204 | <seglistitem>
|
---|
205 | <seg>
|
---|
206 | None
|
---|
207 | </seg>
|
---|
208 | <seg>
|
---|
209 | libical_cxx.so, libical.so, libicalss_cxx.so, libicalss.so,
|
---|
210 | and libicalvcal.so
|
---|
211 | </seg>
|
---|
212 | <seg>
|
---|
213 | /usr/include/libical, /usr/lib/cmake/LibIcal and
|
---|
214 | /usr/share/doc/libical-&libical-version;/html
|
---|
215 | </seg>
|
---|
216 | </seglistitem>
|
---|
217 | </segmentedlist>
|
---|
218 |
|
---|
219 | <variablelist>
|
---|
220 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
221 | <?dbfo list-presentation="list"?>
|
---|
222 | <?dbhtml list-presentation="table"?>
|
---|
223 |
|
---|
224 | <varlistentry id="libical-lib">
|
---|
225 | <term><filename class="libraryfile">libical.so</filename></term>
|
---|
226 | <listitem>
|
---|
227 | <para>
|
---|
228 | contains the <application>libical</application> API
|
---|
229 | functions.
|
---|
230 | </para>
|
---|
231 | <indexterm zone="libical libical-lib">
|
---|
232 | <primary sortas="c-libical">libical.so</primary>
|
---|
233 | </indexterm>
|
---|
234 | </listitem>
|
---|
235 | </varlistentry>
|
---|
236 |
|
---|
237 | <varlistentry id="libical_cxx-lib">
|
---|
238 | <term><filename class="libraryfile">libical_cxx.so</filename></term>
|
---|
239 | <listitem>
|
---|
240 | <para>
|
---|
241 | contains the <application>libical</application> C++ bindings.
|
---|
242 | </para>
|
---|
243 | <indexterm zone="libical libical_cxx-lib">
|
---|
244 | <primary sortas="c-libical_cxx">libical_cxx.so</primary>
|
---|
245 | </indexterm>
|
---|
246 | </listitem>
|
---|
247 | </varlistentry>
|
---|
248 |
|
---|
249 | <varlistentry id="libicalss">
|
---|
250 | <term><filename class="libraryfile">libicalss.so</filename></term>
|
---|
251 | <listitem>
|
---|
252 | <para>
|
---|
253 | is a library that allows you to store iCal component data
|
---|
254 | to disk in a variety of ways.
|
---|
255 | </para>
|
---|
256 | <indexterm zone="libical libicalss">
|
---|
257 | <primary sortas="c-libicalss">libicalss.so</primary>
|
---|
258 | </indexterm>
|
---|
259 | </listitem>
|
---|
260 | </varlistentry>
|
---|
261 |
|
---|
262 | <varlistentry id="libicalss_cxx">
|
---|
263 | <term><filename class="libraryfile">libicalss_cxx.so</filename></term>
|
---|
264 | <listitem>
|
---|
265 | <para>
|
---|
266 | contains the <application>libicalss</application> C++
|
---|
267 | bindings.
|
---|
268 | </para>
|
---|
269 | <indexterm zone="libical libicalss_cxx">
|
---|
270 | <primary sortas="c-libicalss_cxx">libicalss_cxx.so</primary>
|
---|
271 | </indexterm>
|
---|
272 | </listitem>
|
---|
273 | </varlistentry>
|
---|
274 |
|
---|
275 | <varlistentry id="libicalvcal">
|
---|
276 | <term><filename class="libraryfile">libicalvcal.so</filename></term>
|
---|
277 | <listitem>
|
---|
278 | <para>
|
---|
279 | is a vCard/vCalendar C interface.
|
---|
280 | </para>
|
---|
281 | <indexterm zone="libical libicalvcal">
|
---|
282 | <primary sortas="c-libicalvcal">libicalvcal.so</primary>
|
---|
283 | </indexterm>
|
---|
284 | </listitem>
|
---|
285 | </varlistentry>
|
---|
286 |
|
---|
287 | </variablelist>
|
---|
288 |
|
---|
289 | </sect2>
|
---|
290 |
|
---|
291 | </sect1>
|
---|