source: general/genlib/libical.xml@ cbcf148

11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since cbcf148 was 3f2db3a6, checked in by Pierre Labastie <pierre.labastie@…>, 18 months ago

Remove sect1info tags

They only contain a date tag that is nowhere used.
  • Property mode set to 100644
File size: 10.0 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 "3799f9dde1db6f7eb0cb112b5e14ab60">
10 <!ENTITY libical-size "900 KB">
11 <!ENTITY libical-buildsize "24 MB (with tests and API documentation)">
12 <!ENTITY libical-time "0.3 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
20 <title>libical-&libical-version;</title>
21
22 <indexterm zone="libical">
23 <primary sortas="a-libical">libical</primary>
24 </indexterm>
25
26 <sect2 role="package">
27 <title>Introduction to libical</title>
28
29 <para>
30 The <application>libical</application> package contains an implementation
31 of the iCalendar protocols and data formats.
32 </para>
33
34 &lfs112_checked;
35
36 <bridgehead renderas="sect3">Package Information</bridgehead>
37
38 <itemizedlist spacing="compact">
39 <listitem>
40 <para>
41 Download (HTTP): <ulink url="&libical-download-http;"/>
42 </para>
43 </listitem>
44 <listitem>
45 <para>
46 Download (FTP): <ulink url="&libical-download-ftp;"/>
47 </para>
48 </listitem>
49 <listitem>
50 <para>
51 Download MD5 sum: &libical-md5sum;
52 </para>
53 </listitem>
54 <listitem>
55 <para>
56 Download size: &libical-size;
57 </para>
58 </listitem>
59 <listitem>
60 <para>
61 Estimated disk space required: &libical-buildsize;
62 </para>
63 </listitem>
64 <listitem>
65 <para>
66 Estimated build time: &libical-time;
67 </para>
68 </listitem>
69 </itemizedlist>
70
71 <bridgehead renderas="sect3">libical Dependencies</bridgehead>
72
73 <bridgehead renderas="sect4">Required</bridgehead>
74 <para role="required">
75 <xref linkend="cmake"/>
76 </para>
77
78 <bridgehead renderas="sect4">Recommended</bridgehead>
79 <para role="recommended">
80 <xref linkend="gobject-introspection"/> and
81 <xref linkend="vala"/> (both required for GNOME)
82 </para>
83
84 <bridgehead renderas="sect4">Optional</bridgehead>
85 <para role="optional">
86 <xref linkend="db"/>,
87 <xref linkend="doxygen"/> (for the API documentation),
88 <xref linkend="graphviz"/> (for the API documentation),
89 <xref linkend="gtk-doc"/> (for the API documentation),
90 <xref linkend="icu"/>, and
91 <xref linkend="pygobject3"/> (for some tests)
92 </para>
93
94 <para condition="html" role="usernotes">User Notes:
95 <ulink url="&blfs-wiki;/libical"/>
96 </para>
97 </sect2>
98
99 <sect2 role="installation">
100 <title>Installation of libical</title>
101
102<!-- Not needed with 3.0.9
103 <para>First make some fixes for the latest versions of icu and Python:</para>
104
105<screen><userinput>sed -i '/define LEAP_MONTH/a #define FALSE 0' src/libical/icalrecur.c &amp;&amp;
106sed -i 's/array/arraytest/' src/test/libical-glib/CMakeLists.txt &amp;&amp;
107mv src/test/libical-glib/array.py src/test/libical-glib/arraytest.py</userinput></screen>
108-->
109
110 <para>
111 Install <application>libical</application> by running the
112 following commands:
113 </para>
114
115 <!-- Needs confirmation, but I got a race condition at -j8,
116 -j1 allowed the build to pass. Pierre 2019-12-06
117 I always have it actually. Hence the entity.-->
118 &parallel_issues;
119<screen><userinput>mkdir build &amp;&amp;
120cd build &amp;&amp;
121
122cmake -DCMAKE_INSTALL_PREFIX=/usr \
123 -DCMAKE_BUILD_TYPE=Release \
124 -DSHARED_ONLY=yes \
125 -DICAL_BUILD_DOCS=false \
126 -DGOBJECT_INTROSPECTION=true \
127 -DICAL_GLIB_VAPI=true \
128 .. &amp;&amp;
129make -j1</userinput></screen>
130
131 <para>
132 If you have <xref linkend="doxygen"/>, <xref linkend="graphviz"/>,
133 and <xref linkend="gtk-doc"/>
134 installed and wish to build the API documentation, you should
135 remove the <parameter>-DICAL_BUILD_DOCS=false</parameter> switch
136 and issue:
137 </para>
138
139<screen remap="doc"><userinput>make docs</userinput></screen>
140
141 <para>
142 To test the results, issue: <command>make test</command>.
143 <!-- One test, timezones, is known to fail on SysV systems. -->
144 <!-- On systemd, we symlink the current timezone to
145 /etc/localtime, which is what libical expects.
146 This is now done on SysV as well.-->
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"
161 remap="doc"><userinput>install -vdm755 /usr/share/doc/libical-&libical-version;/html &amp;&amp;
162cp -vr apidocs/html/* /usr/share/doc/libical-&libical-version;/html</userinput></screen>
163
164 </sect2>
165
166 <sect2 role="commands">
167 <title>Command Explanations</title>
168
169 <para>
170 <parameter>-DCMAKE_BUILD_TYPE=Release</parameter>: This switch is used
171 to apply higher level of the compiler optimizations.
172 </para>
173
174 <para>
175 <parameter>-DSHARED_ONLY=yes</parameter>: This switch is used
176 in order to only build the shared libraries.
177 </para>
178
179 <para>
180 <parameter>-DICAL_BUILD_DOCS=false</parameter>: This switch prevents
181 building the <application>GTK</application> documentation. Remove
182 if you want to build the documentation.
183 </para>
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 /usr/share/gtk-doc/html/libical-glib (optional),
239 and /usr/share/doc/libical-&libical-version;/html
240 </seg>
241 </seglistitem>
242 </segmentedlist>
243
244 <variablelist>
245 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
246 <?dbfo list-presentation="list"?>
247 <?dbhtml list-presentation="table"?>
248
249 <varlistentry id="libical-lib">
250 <term><filename class="libraryfile">libical.so</filename></term>
251 <listitem>
252 <para>
253 contains the <application>libical</application> API
254 functions
255 </para>
256 <indexterm zone="libical libical-lib">
257 <primary sortas="c-libical">libical.so</primary>
258 </indexterm>
259 </listitem>
260 </varlistentry>
261
262 <varlistentry id="libical_cxx-lib">
263 <term><filename class="libraryfile">libical_cxx.so</filename></term>
264 <listitem>
265 <para>
266 contains the <application>libical</application> C++ bindings
267 </para>
268 <indexterm zone="libical libical_cxx-lib">
269 <primary sortas="c-libical_cxx">libical_cxx.so</primary>
270 </indexterm>
271 </listitem>
272 </varlistentry>
273
274 <varlistentry id="libical-glib">
275 <term><filename class="libraryfile">libical-glib.so</filename></term>
276 <listitem>
277 <para>
278 contains the <application>libical</application> glib bindings
279 </para>
280 <indexterm zone="libical libical-glib">
281 <primary sortas="c-libical-glib">libical-glib.so</primary>
282 </indexterm>
283 </listitem>
284 </varlistentry>
285
286 <varlistentry id="libicalss">
287 <term><filename class="libraryfile">libicalss.so</filename></term>
288 <listitem>
289 <para>
290 is a library that allows you to store iCal component data
291 to disk in a variety of ways
292 </para>
293 <indexterm zone="libical libicalss">
294 <primary sortas="c-libicalss">libicalss.so</primary>
295 </indexterm>
296 </listitem>
297 </varlistentry>
298
299 <varlistentry id="libicalss_cxx">
300 <term><filename class="libraryfile">libicalss_cxx.so</filename></term>
301 <listitem>
302 <para>
303 contains the <application>libicalss</application> C++
304 bindings
305 </para>
306 <indexterm zone="libical libicalss_cxx">
307 <primary sortas="c-libicalss_cxx">libicalss_cxx.so</primary>
308 </indexterm>
309 </listitem>
310 </varlistentry>
311
312 <varlistentry id="libicalvcal">
313 <term><filename class="libraryfile">libicalvcal.so</filename></term>
314 <listitem>
315 <para>
316 is a vCard/vCalendar C interface
317 </para>
318 <indexterm zone="libical libicalvcal">
319 <primary sortas="c-libicalvcal">libicalvcal.so</primary>
320 </indexterm>
321 </listitem>
322 </varlistentry>
323
324 </variablelist>
325
326 </sect2>
327
328</sect1>
Note: See TracBrowser for help on using the repository browser.