source: general/genlib/libical.xml@ ad8b716

12.2 gimp3 lazarus trunk xry111/for-12.3 xry111/spidermonkey128
Last change on this file since ad8b716 was ad8b716, checked in by Bruce Dubbs <bdubbs@…>, 2 months ago

onsolidate qt5 pages.

Remove the page for a full qt5 install.
Remove qt5-components

Rename qt5-alternate to qt5-components adding instructions to optionally
add qtdoc and qtmultimedia to the build.
  • Property mode set to 100644
File size: 10.0 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
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 "cc790ea49701df0335d42b89d57c04bc">
10 <!ENTITY libical-size "888 KB">
11 <!ENTITY libical-buildsize "24 MB (with tests)">
12 <!ENTITY libical-time "0.1 SBU (using parallelism=4; with tests)">
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 &lfs121_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 &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="doxygen"/> (for the API documentation),
87 <xref linkend="graphviz"/> (for the API documentation),
88 <xref linkend="gtk-doc"/> (for the API documentation),
89 <xref linkend="icu"/>,
90 <xref linkend="pygobject3"/> (for some tests), and
91 &berkeley-db;
92 </para>
93
94 </sect2>
95
96 <sect2 role="installation">
97 <title>Installation of libical</title>
98
99 <!-- https://github.com/libical/libical/pull/690 -->
100 <para>
101 If <xref linkend='icu'/> is installed, fix an incompatibility
102 with ICU 75 or later:
103 </para>
104
105 <screen><userinput>sed -i '/getKeywordValuesForLocale/s/NULL/""/' src/libical/icalrecur.c</userinput></screen>
106
107 <para>
108 Install <application>libical</application> by running the
109 following commands:
110 </para>
111
112 <!-- Needs confirmation, but I got a race condition at -j8,
113 -j1 allowed the build to pass. Pierre 2019-12-06
114 I always have it actually. Hence the entity.
115
116 Works at -j8 and -j4 for version 3.0.18
117 &parallel_issues;-->
118<screen><userinput>mkdir build &amp;&amp;
119cd build &amp;&amp;
120
121cmake -D CMAKE_INSTALL_PREFIX=/usr \
122 -D CMAKE_BUILD_TYPE=Release \
123 -D SHARED_ONLY=yes \
124 -D ICAL_BUILD_DOCS=false \
125 -D ICAL_BUILD_EXAMPLES=false \
126 -D GOBJECT_INTROSPECTION=true \
127 -D ICAL_GLIB_VAPI=true \
128 .. &amp;&amp;
129make</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 <!-- https://github.com/libical/libical/pull/684
142 It looks like an ICU bug but I've not got time to investigate
143 carefully. -->
144 <para>
145 To test the results, issue: <command>make test</command>.
146 One test named <literal>icalrecurtest-r</literal> is known to fail.
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>-D CMAKE_BUILD_TYPE=Release</parameter>: This switch is used
171 to apply higher level of the compiler optimizations.
172 </para>
173
174 <para>
175 <parameter>-D SHARED_ONLY=yes</parameter>: This switch is used
176 in order to only build the shared libraries.
177 </para>
178
179 <para>
180 <parameter>-D ICAL_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>-D ICAL_BUILD_EXAMPLES=false</parameter>: This switch prevents
187 building examples. Remove if you want to build them.
188 </para>
189
190 <para>
191 <parameter>-D GOBJECT_INTROSPECTION=true</parameter>: This switch is used
192 to generate GObject metadata bindings.
193 </para>
194
195 <para>
196 <parameter>-D ICAL_GLIB_VAPI=true</parameter>: This switch is used
197 in order to build bindings for <xref linkend="vala"/>.
198 </para>
199
200 <para>
201 <option>-D USE_BUILTIN_TZDATA=yes</option>: This switch is used
202 in order to build using your own timezone data.
203 </para>
204
205 <!-- No CMake equivalents
206 <para>
207 <parameter>- -enable-cxx</parameter>: This switch enables
208 <application>libical</application> C++ library.
209 </para>
210
211 <para>
212 <option>- -enable-python</option>: This switch enables
213 <application>libical</application> Python bindings.
214 </para> -->
215
216 </sect2>
217
218 <sect2 role="content">
219 <title>Contents</title>
220
221 <segmentedlist>
222 <segtitle>Installed Programs</segtitle>
223 <segtitle>Installed Libraries</segtitle>
224 <segtitle>Installed Directory</segtitle>
225
226 <seglistitem>
227 <seg>
228 None
229 </seg>
230 <seg>
231 libical_cxx.so,
232 libical.so,
233 libical-glib.so,
234 libicalss_cxx.so,
235 libicalss.so,
236 and libicalvcal.so
237 </seg>
238 <seg>
239 /usr/include/libical,
240 /usr/include/libical-glib,
241 /usr/lib/cmake/LibIcal,
242 /usr/libexec/libical,
243 /usr/share/gtk-doc/html/libical-glib (optional),
244 and /usr/share/doc/libical-&libical-version;/html
245 </seg>
246 </seglistitem>
247 </segmentedlist>
248
249 <variablelist>
250 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
251 <?dbfo list-presentation="list"?>
252 <?dbhtml list-presentation="table"?>
253
254 <varlistentry id="libical-lib">
255 <term><filename class="libraryfile">libical.so</filename></term>
256 <listitem>
257 <para>
258 contains the <application>libical</application> API
259 functions
260 </para>
261 <indexterm zone="libical libical-lib">
262 <primary sortas="c-libical">libical.so</primary>
263 </indexterm>
264 </listitem>
265 </varlistentry>
266
267 <varlistentry id="libical_cxx-lib">
268 <term><filename class="libraryfile">libical_cxx.so</filename></term>
269 <listitem>
270 <para>
271 contains the <application>libical</application> C++ bindings
272 </para>
273 <indexterm zone="libical libical_cxx-lib">
274 <primary sortas="c-libical_cxx">libical_cxx.so</primary>
275 </indexterm>
276 </listitem>
277 </varlistentry>
278
279 <varlistentry id="libical-glib">
280 <term><filename class="libraryfile">libical-glib.so</filename></term>
281 <listitem>
282 <para>
283 contains the <application>libical</application> glib bindings
284 </para>
285 <indexterm zone="libical libical-glib">
286 <primary sortas="c-libical-glib">libical-glib.so</primary>
287 </indexterm>
288 </listitem>
289 </varlistentry>
290
291 <varlistentry id="libicalss">
292 <term><filename class="libraryfile">libicalss.so</filename></term>
293 <listitem>
294 <para>
295 is a library that allows you to store iCal component data
296 to disk in a variety of ways
297 </para>
298 <indexterm zone="libical libicalss">
299 <primary sortas="c-libicalss">libicalss.so</primary>
300 </indexterm>
301 </listitem>
302 </varlistentry>
303
304 <varlistentry id="libicalss_cxx">
305 <term><filename class="libraryfile">libicalss_cxx.so</filename></term>
306 <listitem>
307 <para>
308 contains the <application>libicalss</application> C++
309 bindings
310 </para>
311 <indexterm zone="libical libicalss_cxx">
312 <primary sortas="c-libicalss_cxx">libicalss_cxx.so</primary>
313 </indexterm>
314 </listitem>
315 </varlistentry>
316
317 <varlistentry id="libicalvcal">
318 <term><filename class="libraryfile">libicalvcal.so</filename></term>
319 <listitem>
320 <para>
321 is a vCard/vCalendar C interface
322 </para>
323 <indexterm zone="libical libicalvcal">
324 <primary sortas="c-libicalvcal">libicalvcal.so</primary>
325 </indexterm>
326 </listitem>
327 </varlistentry>
328
329 </variablelist>
330
331 </sect2>
332
333</sect1>
Note: See TracBrowser for help on using the repository browser.