source: general/genlib/libical.xml@ 9029db2

10.1 11.0 11.1 11.2 11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since 9029db2 was 9029db2, checked in by Bruce Dubbs <bdubbs@…>, 3 years ago

Tag most of General Libraries and dependencies

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@24241 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 9.8 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 "734099cc0b0f52bdcc5e3e191a0d9769">
10 <!ENTITY libical-size "868 KB">
11 <!ENTITY libical-buildsize "27 MB (with tests)">
12 <!ENTITY libical-time "0.2 SBU (Using parallelism=4; with tests)">
13]>
14
15<sect1 id="libical" xreflabel="libical-&libical-version;">
16 <?dbhtml filename="libical.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
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 &lfs101_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="gtk-doc"/> (for the API documentation),
92 <xref linkend="icu"/>, and
93 <xref linkend="pygobject3"/> (for some tests)
94 </para>
95
96 <para condition="html" role="usernotes">User Notes:
97 <ulink url="&blfs-wiki;/libical"/>
98 </para>
99 </sect2>
100
101 <sect2 role="installation">
102 <title>Installation of libical</title>
103
104<!-- Not needed with 3.0.9
105 <para>First make some fixes for the latest versions of icu and Python:</para>
106
107<screen><userinput>sed -i '/define LEAP_MONTH/a #define FALSE 0' src/libical/icalrecur.c &amp;&amp;
108sed -i 's/array/arraytest/' src/test/libical-glib/CMakeLists.txt &amp;&amp;
109mv src/test/libical-glib/array.py src/test/libical-glib/arraytest.py</userinput></screen>
110-->
111
112 <para>
113 Install <application>libical</application> by running the
114 following commands:
115 </para>
116
117 <!-- Needs confirmation, but I got a race condition at -j8,
118 -j1 allowed the build to pass. Pierre 2019-12-06
119 I always have it actually. Hence the entity.-->
120 &parallel_issues;
121<screen><userinput>mkdir build &amp;&amp;
122cd build &amp;&amp;
123
124cmake -DCMAKE_INSTALL_PREFIX=/usr \
125 -DCMAKE_BUILD_TYPE=Release \
126 -DSHARED_ONLY=yes \
127 -DICAL_BUILD_DOCS=false \
128 -DGOBJECT_INTROSPECTION=true \
129 -DICAL_GLIB_VAPI=true \
130 .. &amp;&amp;
131make</userinput></screen>
132
133 <para>
134 If you have <xref linkend="doxygen"/> and <xref linkend="gtk-doc"/>
135 installed and wish to build the API documentation, issue:
136 </para>
137
138<screen remap="doc"><userinput>make docs</userinput></screen>
139
140 <para>
141 To test the results, issue: <command>make test</command>.
142 <!-- One test, timezones, is known to fail on SysV systems. -->
143 <!-- On systemd, we symlink the current timezone to
144 /etc/localtime, which is what libical expects.
145 This is now done on SysV as well.-->
146 </para>
147
148 <para>
149 Now, as the <systemitem class="username">root</systemitem> user:
150 </para>
151
152<screen role="root"><userinput>make install</userinput></screen>
153
154 <para>
155 If you have built the API documentation, install by issuing, as
156 <systemitem class="username">root</systemitem> user:
157 </para>
158
159<screen role="root"
160 remap="doc"><userinput>install -vdm755 /usr/share/doc/libical-&libical-version;/html &amp;&amp;
161cp -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 <!--
179 <para>
180 <parameter>-DICAL_BUILD_DOCS=false</parameter>: This switch prevents
181 building the <application>GTK</application> documentation.
182 </para>
183 -->
184
185 <para>
186 <parameter>-DGOBJECT_INTROSPECTION=true</parameter>: This switch is used
187 to generate GObject metadata bindings.
188 </para>
189
190 <para>
191 <parameter>-DICAL_GLIB_VAPI=true</parameter>: This switch is used
192 in order to build bindings for <xref linkend="vala"/>.
193 </para>
194
195 <para>
196 <option>-DUSE_BUILTIN_TZDATA=yes</option>: This switch is used
197 in order to build using your own timezone data.
198 </para>
199
200 <!-- No CMake equivalents
201 <para>
202 <parameter>- -enable-cxx</parameter>: This switch enables
203 <application>libical</application> C++ library.
204 </para>
205
206 <para>
207 <option>- -enable-python</option>: This switch enables
208 <application>libical</application> Python bindings.
209 </para> -->
210
211 </sect2>
212
213 <sect2 role="content">
214 <title>Contents</title>
215
216 <segmentedlist>
217 <segtitle>Installed Programs</segtitle>
218 <segtitle>Installed Libraries</segtitle>
219 <segtitle>Installed Directory</segtitle>
220
221 <seglistitem>
222 <seg>
223 None
224 </seg>
225 <seg>
226 libical_cxx.so,
227 libical.so,
228 libical-glib.so,
229 libicalss_cxx.so,
230 libicalss.so,
231 and libicalvcal.so
232 </seg>
233 <seg>
234 /usr/include/libical,
235 /usr/include/libical-glib,
236 /usr/lib/cmake/LibIcal,
237 /usr/libexec/libical,
238 and /usr/share/doc/libical-&libical-version;/html
239 </seg>
240 </seglistitem>
241 </segmentedlist>
242
243 <variablelist>
244 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
245 <?dbfo list-presentation="list"?>
246 <?dbhtml list-presentation="table"?>
247
248 <varlistentry id="libical-lib">
249 <term><filename class="libraryfile">libical.so</filename></term>
250 <listitem>
251 <para>
252 contains the <application>libical</application> API
253 functions
254 </para>
255 <indexterm zone="libical libical-lib">
256 <primary sortas="c-libical">libical.so</primary>
257 </indexterm>
258 </listitem>
259 </varlistentry>
260
261 <varlistentry id="libical_cxx-lib">
262 <term><filename class="libraryfile">libical_cxx.so</filename></term>
263 <listitem>
264 <para>
265 contains the <application>libical</application> C++ bindings
266 </para>
267 <indexterm zone="libical libical_cxx-lib">
268 <primary sortas="c-libical_cxx">libical_cxx.so</primary>
269 </indexterm>
270 </listitem>
271 </varlistentry>
272
273 <varlistentry id="libical-glib">
274 <term><filename class="libraryfile">libical-glib.so</filename></term>
275 <listitem>
276 <para>
277 contains the <application>libical</application> glib bindings
278 </para>
279 <indexterm zone="libical libical-glib">
280 <primary sortas="c-libical-glib">libical-glib.so</primary>
281 </indexterm>
282 </listitem>
283 </varlistentry>
284
285 <varlistentry id="libicalss">
286 <term><filename class="libraryfile">libicalss.so</filename></term>
287 <listitem>
288 <para>
289 is a library that allows you to store iCal component data
290 to disk in a variety of ways
291 </para>
292 <indexterm zone="libical libicalss">
293 <primary sortas="c-libicalss">libicalss.so</primary>
294 </indexterm>
295 </listitem>
296 </varlistentry>
297
298 <varlistentry id="libicalss_cxx">
299 <term><filename class="libraryfile">libicalss_cxx.so</filename></term>
300 <listitem>
301 <para>
302 contains the <application>libicalss</application> C++
303 bindings
304 </para>
305 <indexterm zone="libical libicalss_cxx">
306 <primary sortas="c-libicalss_cxx">libicalss_cxx.so</primary>
307 </indexterm>
308 </listitem>
309 </varlistentry>
310
311 <varlistentry id="libicalvcal">
312 <term><filename class="libraryfile">libicalvcal.so</filename></term>
313 <listitem>
314 <para>
315 is a vCard/vCalendar C interface
316 </para>
317 <indexterm zone="libical libicalvcal">
318 <primary sortas="c-libicalvcal">libicalvcal.so</primary>
319 </indexterm>
320 </listitem>
321 </varlistentry>
322
323 </variablelist>
324
325 </sect2>
326
327</sect1>
Note: See TracBrowser for help on using the repository browser.