source: general/genlib/libical.xml@ e9b9a70

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 e9b9a70 was e9b9a70, checked in by Douglas R. Reno <renodr@…>, 3 years ago

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