source: general/genlib/libical.xml@ 113f4e6

11.1 11.2 lazarus trunk xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since 113f4e6 was 113f4e6, checked in by Pierre Labastie <pierre.labastie@…>, 8 months ago

Package updates

gnutls-3.7.3 (security fix)
libical-3.0.13
folks-0.15.4
umockdev-0.17.5

  • Property mode set to 100644
File size: 10.1 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 libical-download-http "https://github.com/libical/libical/releases/download/v&libical-version;/libical-&libical-version;.tar.gz">
8 <!ENTITY libical-download-ftp " ">
9 <!ENTITY libical-md5sum "5b6c28bfeedef4179c1c7a7fd9ed3b23">
10 <!ENTITY libical-size "866 KB">
11 <!ENTITY libical-buildsize "52 MB (with tests and API documentation)">
12 <!ENTITY libical-time "0.4 SBU (with tests and documentation)">
13<!-- run at -j1 because it fails at -j4 -->
14]>
15
16<sect1 id="libical" xreflabel="libical-&libical-version;">
17 <?dbhtml filename="libical.html"?>
18
19 <sect1info>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>libical-&libical-version;</title>
24
25 <indexterm zone="libical">
26 <primary sortas="a-libical">libical</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to libical</title>
31
32 <para>
33 The <application>libical</application> package contains an implementation
34 of the iCalendar protocols and data formats.
35 </para>
36
37 &lfs110a_checked;
38
39 <bridgehead renderas="sect3">Package Information</bridgehead>
40
41 <itemizedlist spacing="compact">
42 <listitem>
43 <para>
44 Download (HTTP): <ulink url="&libical-download-http;"/>
45 </para>
46 </listitem>
47 <listitem>
48 <para>
49 Download (FTP): <ulink url="&libical-download-ftp;"/>
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download MD5 sum: &libical-md5sum;
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Download size: &libical-size;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Estimated disk space required: &libical-buildsize;
65 </para>
66 </listitem>
67 <listitem>
68 <para>
69 Estimated build time: &libical-time;
70 </para>
71 </listitem>
72 </itemizedlist>
73
74 <bridgehead renderas="sect3">libical Dependencies</bridgehead>
75
76 <bridgehead renderas="sect4">Required</bridgehead>
77 <para role="required">
78 <xref linkend="cmake"/>
79 </para>
80
81 <bridgehead renderas="sect4">Recommended</bridgehead>
82 <para role="recommended">
83 <xref linkend="gobject-introspection"/> and
84 <xref linkend="vala"/> (both required for GNOME)
85 </para>
86
87 <bridgehead renderas="sect4">Optional</bridgehead>
88 <para role="optional">
89 <xref linkend="db"/>,
90 <xref linkend="doxygen"/> (for the API documentation),
91 <xref linkend="graphviz"/> (for the API documentation),
92 <xref linkend="gtk-doc"/> (for the API documentation),
93 <xref linkend="icu"/>, and
94 <xref linkend="pygobject3"/> (for some tests)
95 </para>
96
97 <para condition="html" role="usernotes">User Notes:
98 <ulink url="&blfs-wiki;/libical"/>
99 </para>
100 </sect2>
101
102 <sect2 role="installation">
103 <title>Installation of libical</title>
104
105<!-- Not needed with 3.0.9
106 <para>First make some fixes for the latest versions of icu and Python:</para>
107
108<screen><userinput>sed -i '/define LEAP_MONTH/a #define FALSE 0' src/libical/icalrecur.c &amp;&amp;
109sed -i 's/array/arraytest/' src/test/libical-glib/CMakeLists.txt &amp;&amp;
110mv src/test/libical-glib/array.py src/test/libical-glib/arraytest.py</userinput></screen>
111-->
112
113 <para>
114 Install <application>libical</application> by running the
115 following commands:
116 </para>
117
118 <!-- Needs confirmation, but I got a race condition at -j8,
119 -j1 allowed the build to pass. Pierre 2019-12-06
120 I always have it actually. Hence the entity.-->
121 &parallel_issues;
122<screen><userinput>mkdir build &amp;&amp;
123cd build &amp;&amp;
124
125cmake -DCMAKE_INSTALL_PREFIX=/usr \
126 -DCMAKE_BUILD_TYPE=Release \
127 -DSHARED_ONLY=yes \
128 -DICAL_BUILD_DOCS=false \
129 -DGOBJECT_INTROSPECTION=true \
130 -DICAL_GLIB_VAPI=true \
131 .. &amp;&amp;
132make</userinput></screen>
133
134 <para>
135 If you have <xref linkend="doxygen"/>, <xref linkend="graphviz"/>,
136 and <xref linkend="gtk-doc"/>
137 installed and wish to build the API documentation, you should
138 remove the <parameter>-DICAL_BUILD_DOCS=false</parameter> switch
139 and issue:
140 </para>
141
142<screen remap="doc"><userinput>make docs</userinput></screen>
143
144 <para>
145 To test the results, issue: <command>make test</command>.
146 <!-- One test, timezones, is known to fail on SysV systems. -->
147 <!-- On systemd, we symlink the current timezone to
148 /etc/localtime, which is what libical expects.
149 This is now done on SysV as well.-->
150 </para>
151
152 <para>
153 Now, as the <systemitem class="username">root</systemitem> user:
154 </para>
155
156<screen role="root"><userinput>make install</userinput></screen>
157
158 <para>
159 If you have built the API documentation, install by issuing, as
160 <systemitem class="username">root</systemitem> user:
161 </para>
162
163<screen role="root"
164 remap="doc"><userinput>install -vdm755 /usr/share/doc/libical-&libical-version;/html &amp;&amp;
165cp -vr apidocs/html/* /usr/share/doc/libical-&libical-version;/html</userinput></screen>
166
167 </sect2>
168
169 <sect2 role="commands">
170 <title>Command Explanations</title>
171
172 <para>
173 <parameter>-DCMAKE_BUILD_TYPE=Release</parameter>: This switch is used
174 to apply higher level of the compiler optimizations.
175 </para>
176
177 <para>
178 <parameter>-DSHARED_ONLY=yes</parameter>: This switch is used
179 in order to only build the shared libraries.
180 </para>
181
182 <para>
183 <parameter>-DICAL_BUILD_DOCS=false</parameter>: This switch prevents
184 building the <application>GTK</application> documentation. Remove
185 if you want to build the documentation.
186 </para>
187
188 <para>
189 <parameter>-DGOBJECT_INTROSPECTION=true</parameter>: This switch is used
190 to generate GObject metadata bindings.
191 </para>
192
193 <para>
194 <parameter>-DICAL_GLIB_VAPI=true</parameter>: This switch is used
195 in order to build bindings for <xref linkend="vala"/>.
196 </para>
197
198 <para>
199 <option>-DUSE_BUILTIN_TZDATA=yes</option>: This switch is used
200 in order to build using your own timezone data.
201 </para>
202
203 <!-- No CMake equivalents
204 <para>
205 <parameter>- -enable-cxx</parameter>: This switch enables
206 <application>libical</application> C++ library.
207 </para>
208
209 <para>
210 <option>- -enable-python</option>: This switch enables
211 <application>libical</application> Python bindings.
212 </para> -->
213
214 </sect2>
215
216 <sect2 role="content">
217 <title>Contents</title>
218
219 <segmentedlist>
220 <segtitle>Installed Programs</segtitle>
221 <segtitle>Installed Libraries</segtitle>
222 <segtitle>Installed Directory</segtitle>
223
224 <seglistitem>
225 <seg>
226 None
227 </seg>
228 <seg>
229 libical_cxx.so,
230 libical.so,
231 libical-glib.so,
232 libicalss_cxx.so,
233 libicalss.so,
234 and libicalvcal.so
235 </seg>
236 <seg>
237 /usr/include/libical,
238 /usr/include/libical-glib,
239 /usr/lib/cmake/LibIcal,
240 /usr/libexec/libical,
241 /usr/share/gtk-doc/html/libical-glib (optional),
242 and /usr/share/doc/libical-&libical-version;/html
243 </seg>
244 </seglistitem>
245 </segmentedlist>
246
247 <variablelist>
248 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
249 <?dbfo list-presentation="list"?>
250 <?dbhtml list-presentation="table"?>
251
252 <varlistentry id="libical-lib">
253 <term><filename class="libraryfile">libical.so</filename></term>
254 <listitem>
255 <para>
256 contains the <application>libical</application> API
257 functions
258 </para>
259 <indexterm zone="libical libical-lib">
260 <primary sortas="c-libical">libical.so</primary>
261 </indexterm>
262 </listitem>
263 </varlistentry>
264
265 <varlistentry id="libical_cxx-lib">
266 <term><filename class="libraryfile">libical_cxx.so</filename></term>
267 <listitem>
268 <para>
269 contains the <application>libical</application> C++ bindings
270 </para>
271 <indexterm zone="libical libical_cxx-lib">
272 <primary sortas="c-libical_cxx">libical_cxx.so</primary>
273 </indexterm>
274 </listitem>
275 </varlistentry>
276
277 <varlistentry id="libical-glib">
278 <term><filename class="libraryfile">libical-glib.so</filename></term>
279 <listitem>
280 <para>
281 contains the <application>libical</application> glib bindings
282 </para>
283 <indexterm zone="libical libical-glib">
284 <primary sortas="c-libical-glib">libical-glib.so</primary>
285 </indexterm>
286 </listitem>
287 </varlistentry>
288
289 <varlistentry id="libicalss">
290 <term><filename class="libraryfile">libicalss.so</filename></term>
291 <listitem>
292 <para>
293 is a library that allows you to store iCal component data
294 to disk in a variety of ways
295 </para>
296 <indexterm zone="libical libicalss">
297 <primary sortas="c-libicalss">libicalss.so</primary>
298 </indexterm>
299 </listitem>
300 </varlistentry>
301
302 <varlistentry id="libicalss_cxx">
303 <term><filename class="libraryfile">libicalss_cxx.so</filename></term>
304 <listitem>
305 <para>
306 contains the <application>libicalss</application> C++
307 bindings
308 </para>
309 <indexterm zone="libical libicalss_cxx">
310 <primary sortas="c-libicalss_cxx">libicalss_cxx.so</primary>
311 </indexterm>
312 </listitem>
313 </varlistentry>
314
315 <varlistentry id="libicalvcal">
316 <term><filename class="libraryfile">libicalvcal.so</filename></term>
317 <listitem>
318 <para>
319 is a vCard/vCalendar C interface
320 </para>
321 <indexterm zone="libical libicalvcal">
322 <primary sortas="c-libicalvcal">libicalvcal.so</primary>
323 </indexterm>
324 </listitem>
325 </varlistentry>
326
327 </variablelist>
328
329 </sect2>
330
331</sect1>
Note: See TracBrowser for help on using the repository browser.