source: general/genlib/libical.xml@ 87351a9

10.0 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 87351a9 was 87351a9, checked in by Bruce Dubbs <bdubbs@…>, 4 years ago

Tag most of General Libraries and their dependencies

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@23542 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 9.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 "41bd1f1fcdcb4779cea478bb55cf07bf">
10 <!ENTITY libical-size "864 KB">
11 <!ENTITY libical-buildsize "21 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 &lfs10_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="icu"/>, and
92 <xref linkend="pygobject3"/> (for some tests)
93 </para>
94
95 <para condition="html" role="usernotes">User Notes:
96 <ulink url="&blfs-wiki;/libical"/>
97 </para>
98 </sect2>
99
100 <sect2 role="installation">
101 <title>Installation of libical</title>
102
103 <para>
104 Install <application>libical</application> by running the
105 following commands:
106 </para>
107
108 <!-- Needs confirmation, but I got a race condition at -j8,
109 -j1 allowed the build to pass. Pierre 2019-12-06
110 I always have it actually. Hence the entity.-->
111 &parallel_issues;
112<screen><userinput>mkdir build &amp;&amp;
113cd build &amp;&amp;
114
115cmake -DCMAKE_INSTALL_PREFIX=/usr \
116 -DCMAKE_BUILD_TYPE=Release \
117 -DSHARED_ONLY=yes \
118 -DICAL_BUILD_DOCS=false \
119 -DGOBJECT_INTROSPECTION=true \
120 -DICAL_GLIB_VAPI=true \
121 .. &amp;&amp;
122make</userinput></screen>
123<!-- DEVS: the ICAL_BUILD_DOCS=false switch is needed because gtk-doc-1.30 is
124 broken. Unfortunately, it also prevents running make docs. When gtk-doc
125 is fixed, remove the switch and uncomment this.
126 <para>
127 If you have <xref linkend="doxygen"/> installed and wish to build the API
128 documentation, issue:
129 </para>
130
131<screen remap="doc"><userinput>make docs</userinput></screen>
132-->
133 <para>
134 To test the results, issue: <command>make test</command>.
135 <!-- One test, timezones, is known to fail on SysV systems. -->
136 <!-- On systemd, we symlink the current timezone to
137 /etc/localtime, which is what libical expects.
138 This is now done on SysV as well.-->
139 </para>
140
141 <para>
142 Now, as the <systemitem class="username">root</systemitem> user:
143 </para>
144
145<screen role="root"><userinput>make install</userinput></screen>
146<!-- see above:
147 <para>
148 If you have built the API documentation, install by issuing, as
149 <systemitem class="username">root</systemitem> user:
150 </para>
151
152<screen role="root"
153 remap="doc"><userinput>install -vdm755 /usr/share/doc/libical-&libical-version;/html &amp;&amp;
154cp -vr apidocs/html/* /usr/share/doc/libical-&libical-version;/html</userinput></screen>
155-->
156 </sect2>
157
158 <sect2 role="commands">
159 <title>Command Explanations</title>
160
161 <para>
162 <parameter>-DCMAKE_BUILD_TYPE=Release</parameter>: This switch is used
163 to apply higher level of the compiler optimizations.
164 </para>
165
166 <para>
167 <parameter>-DSHARED_ONLY=yes</parameter>: This switch is used
168 in order to only build the shared libraries.
169 </para>
170
171 <para>
172 <parameter>-DICAL_BUILD_DOCS=false</parameter>: This switch prevents
173 building the <application>GTK</application> documentation, because
174 gtk-doc-1.30 is broken. Unfortunately, it also prevents building the
175 API documentation.
176 </para>
177
178 <para>
179 <parameter>-DGOBJECT_INTROSPECTION=true</parameter>: This switch is used
180 to generate GObject metadata bindings.
181 </para>
182
183 <para>
184 <parameter>-DICAL_GLIB_VAPI=true</parameter>: This switch is used
185 in order to build bindings for <xref linkend="vala"/>.
186 </para>
187
188 <para>
189 <option>-DUSE_BUILTIN_TZDATA=yes</option>: This switch is used
190 in order to build using your own timezone data.
191 </para>
192
193 <!-- No CMake equivalents
194 <para>
195 <parameter>- -enable-cxx</parameter>: This switch enables
196 <application>libical</application> C++ library.
197 </para>
198
199 <para>
200 <option>- -enable-python</option>: This switch enables
201 <application>libical</application> Python bindings.
202 </para> -->
203
204 </sect2>
205
206 <sect2 role="content">
207 <title>Contents</title>
208
209 <segmentedlist>
210 <segtitle>Installed Programs</segtitle>
211 <segtitle>Installed Libraries</segtitle>
212 <segtitle>Installed Directory</segtitle>
213
214 <seglistitem>
215 <seg>
216 None
217 </seg>
218 <seg>
219 libical_cxx.so, libical.so, libicalss_cxx.so, libicalss.so,
220 and libicalvcal.so
221 </seg>
222 <seg>
223 /usr/include/libical, /usr/lib/cmake/LibIcal and
224 /usr/share/doc/libical-&libical-version;/html
225 </seg>
226 </seglistitem>
227 </segmentedlist>
228
229 <variablelist>
230 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
231 <?dbfo list-presentation="list"?>
232 <?dbhtml list-presentation="table"?>
233
234 <varlistentry id="libical-lib">
235 <term><filename class="libraryfile">libical.so</filename></term>
236 <listitem>
237 <para>
238 contains the <application>libical</application> API
239 functions.
240 </para>
241 <indexterm zone="libical libical-lib">
242 <primary sortas="c-libical">libical.so</primary>
243 </indexterm>
244 </listitem>
245 </varlistentry>
246
247 <varlistentry id="libical_cxx-lib">
248 <term><filename class="libraryfile">libical_cxx.so</filename></term>
249 <listitem>
250 <para>
251 contains the <application>libical</application> C++ bindings.
252 </para>
253 <indexterm zone="libical libical_cxx-lib">
254 <primary sortas="c-libical_cxx">libical_cxx.so</primary>
255 </indexterm>
256 </listitem>
257 </varlistentry>
258
259 <varlistentry id="libicalss">
260 <term><filename class="libraryfile">libicalss.so</filename></term>
261 <listitem>
262 <para>
263 is a library that allows you to store iCal component data
264 to disk in a variety of ways.
265 </para>
266 <indexterm zone="libical libicalss">
267 <primary sortas="c-libicalss">libicalss.so</primary>
268 </indexterm>
269 </listitem>
270 </varlistentry>
271
272 <varlistentry id="libicalss_cxx">
273 <term><filename class="libraryfile">libicalss_cxx.so</filename></term>
274 <listitem>
275 <para>
276 contains the <application>libicalss</application> C++
277 bindings.
278 </para>
279 <indexterm zone="libical libicalss_cxx">
280 <primary sortas="c-libicalss_cxx">libicalss_cxx.so</primary>
281 </indexterm>
282 </listitem>
283 </varlistentry>
284
285 <varlistentry id="libicalvcal">
286 <term><filename class="libraryfile">libicalvcal.so</filename></term>
287 <listitem>
288 <para>
289 is a vCard/vCalendar C interface.
290 </para>
291 <indexterm zone="libical libicalvcal">
292 <primary sortas="c-libicalvcal">libicalvcal.so</primary>
293 </indexterm>
294 </listitem>
295 </varlistentry>
296
297 </variablelist>
298
299 </sect2>
300
301</sect1>
Note: See TracBrowser for help on using the repository browser.