source: general/genlib/libical.xml@ 92245989

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt perl-modules 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 92245989 was 92245989, checked in by DJ Lucas <dj@…>, 7 years ago

Merge nosym branch

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@18076 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 8.9 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 <!--
9 <!ENTITY libical-download-http "https://github.com/libical/libical/archive/v&libical-version;.tar.gz">-->
10 <!ENTITY libical-download-ftp " ">
11 <!ENTITY libical-md5sum "6bf8e5f5a3ba88baf390d0134e05d76e">
12 <!ENTITY libical-size "684 KB">
13 <!ENTITY libical-buildsize "14 MB, with tests (additional 12 MB for the API documentation)">
14 <!ENTITY libical-time "0.3 SBU (with tests and API documentation)">
15]>
16
17<sect1 id="libical" xreflabel="libical-&libical-version;">
18 <?dbhtml filename="libical.html"?>
19
20 <sect1info>
21 <othername>$LastChangedBy$</othername>
22 <date>$Date$</date>
23 </sect1info>
24
25 <title>libical-&libical-version;</title>
26
27 <indexterm zone="libical">
28 <primary sortas="a-libical">libical</primary>
29 </indexterm>
30
31 <sect2 role="package">
32 <title>Introduction to libical</title>
33
34 <para>
35 The <application>libical</application> package contains an implementation
36 of the iCalendar protocols and data formats.
37 </para>
38
39 &lfs7a_checked;
40
41 <bridgehead renderas="sect3">Package Information</bridgehead>
42<!--
43 <note>
44
45 <para>The download link below obtains
46 <filename>libical-&libical-version;.tar.gz</filename> if a web browser
47 such as <xref linkend="firefox"/> is used. This is the correct name
48 for the archive, because it saves the file as <filename
49 class="directory">libical-&libical-version;</filename>. However, if
50 another method is used for downloading, e.g. <xref linkend="wget"/>, the
51 file name is <filename>v&libical-version;.tar.gz</filename>, which is not
52 acceptable. The file should be renamed to the correct filename
53 <filename>libical-&libical-version;.tar.gz</filename>. You can achieve
54 this automatically by using the command:</para>
55
56 <screen><userinput>wget <ulink url="&libical-download-http;"/> -O libical-&libical-version;.tar.gz</userinput></screen>
57 </note>
58-->
59 <itemizedlist spacing="compact">
60 <listitem>
61 <para>
62 Download (HTTP): <ulink url="&libical-download-http;"/>
63 </para>
64 </listitem>
65 <listitem>
66 <para>
67 Download (FTP): <ulink url="&libical-download-ftp;"/>
68 </para>
69 </listitem>
70 <listitem>
71 <para>
72 Download MD5 sum: &libical-md5sum;
73 </para>
74 </listitem>
75 <listitem>
76 <para>
77 Download size: &libical-size;
78 </para>
79 </listitem>
80 <listitem>
81 <para>
82 Estimated disk space required: &libical-buildsize;
83 </para>
84 </listitem>
85 <listitem>
86 <para>
87 Estimated build time: &libical-time;
88 </para>
89 </listitem>
90 </itemizedlist>
91
92 <bridgehead renderas="sect3">libical Dependencies</bridgehead>
93
94 <!-- Upstream recommends to use CMake since autotools
95 doesn't bump soname for 0.48 -> 1.0 incompatibility -->
96 <bridgehead renderas="sect4">Required</bridgehead>
97 <para role="required">
98 <xref linkend="cmake"/>
99 </para>
100
101 <bridgehead renderas="sect4">Optional</bridgehead>
102 <para role="optional">
103 <xref linkend="db"/>,
104 <xref linkend="doxygen"/> (for the API documentation),
105 <xref linkend="gobject-introspection"/>, and
106 <xref linkend="icu"/>
107 </para>
108
109 <!-- Can't be built using CMake
110 <bridgehead renderas="sect4">Optional</bridgehead>
111 <para role="optional">
112 <xref linkend="openjdk"/> and
113 <xref linkend="python2"/> (must have <xref linkend="swig"/> also)
114 </para> -->
115
116 <para condition="html" role="usernotes">User Notes:
117 <ulink url="&blfs-wiki;/libical"/>
118 </para>
119 </sect2>
120
121 <sect2 role="installation">
122 <title>Installation of libical</title>
123
124 <para>
125 Install <application>libical</application> by running the
126 following commands:
127 </para>
128
129<screen><userinput>mkdir build &amp;&amp;
130cd build &amp;&amp;
131
132cmake -DCMAKE_INSTALL_PREFIX=/usr \
133 -DCMAKE_INSTALL_LIBDIR=/usr/lib \
134 -DCMAKE_BUILD_TYPE=Release \
135 -DSHARED_ONLY=yes \
136 .. &amp;&amp;
137make</userinput></screen>
138
139 <para>
140 If you have <xref linkend="doxygen"/> installed and wish to build the API
141 documentation, issue:
142 </para>
143
144<screen><userinput>make docs</userinput></screen>
145
146 <para>
147 To test the results, issue: <command>make test</command>.
148 </para>
149
150 <para>
151 Now, as the <systemitem class="username">root</systemitem> user:
152 </para>
153
154<screen role="root"><userinput>make install</userinput></screen>
155
156 <para>
157 If you have built the API documentation, install by issuing, as
158 <systemitem class="username">root</systemitem> user:
159 </para>
160
161<screen role="root"><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 <option>-DUSE_BUILTIN_TZDATA=yes</option>: This switch is used
181 in order to build using your own timezone data.
182 </para>
183
184 <!-- No CMake equivalents
185 <para>
186 <parameter>- -enable-cxx</parameter>: This switch enables
187 <application>libical</application> C++ library.
188 </para>
189
190 <para>
191 <option>- -enable-python</option>: This switch enables
192 <application>libical</application> Python bindings.
193 </para> -->
194
195 </sect2>
196
197 <sect2 role="content">
198 <title>Contents</title>
199
200 <segmentedlist>
201 <segtitle>Installed Programs</segtitle>
202 <segtitle>Installed Libraries</segtitle>
203 <segtitle>Installed Directory</segtitle>
204
205 <seglistitem>
206 <seg>
207 None
208 </seg>
209 <seg>
210 libical_cxx.so, libical.so, libicalss_cxx.so, libicalss.so,
211 and libicalvcal.so
212 </seg>
213 <seg>
214 /usr/include/libical, /usr/lib/cmake/LibIcal and
215 /usr/share/doc/libical-&libical-version;/html
216 </seg>
217 </seglistitem>
218 </segmentedlist>
219
220 <variablelist>
221 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
222 <?dbfo list-presentation="list"?>
223 <?dbhtml list-presentation="table"?>
224
225 <varlistentry id="libical-lib">
226 <term><filename class="libraryfile">libical.so</filename></term>
227 <listitem>
228 <para>
229 contains the <application>libical</application> API
230 functions.
231 </para>
232 <indexterm zone="libical libical-lib">
233 <primary sortas="c-libical">libical.so</primary>
234 </indexterm>
235 </listitem>
236 </varlistentry>
237
238 <varlistentry id="libical_cxx-lib">
239 <term><filename class="libraryfile">libical_cxx.so</filename></term>
240 <listitem>
241 <para>
242 contains the <application>libical</application> C++ bindings.
243 </para>
244 <indexterm zone="libical libical_cxx-lib">
245 <primary sortas="c-libical_cxx">libical_cxx.so</primary>
246 </indexterm>
247 </listitem>
248 </varlistentry>
249
250 <varlistentry id="libicalss">
251 <term><filename class="libraryfile">libicalss.so</filename></term>
252 <listitem>
253 <para>
254 is a library that allows you to store iCal component data
255 to disk in a variety of ways.
256 </para>
257 <indexterm zone="libical libicalss">
258 <primary sortas="c-libicalss">libicalss.so</primary>
259 </indexterm>
260 </listitem>
261 </varlistentry>
262
263 <varlistentry id="libicalss_cxx">
264 <term><filename class="libraryfile">libicalss_cxx.so</filename></term>
265 <listitem>
266 <para>
267 contains the <application>libicalss</application> C++
268 bindings.
269 </para>
270 <indexterm zone="libical libicalss_cxx">
271 <primary sortas="c-libicalss_cxx">libicalss_cxx.so</primary>
272 </indexterm>
273 </listitem>
274 </varlistentry>
275
276 <varlistentry id="libicalvcal">
277 <term><filename class="libraryfile">libicalvcal.so</filename></term>
278 <listitem>
279 <para>
280 is a vCard/vCalendar C interface.
281 </para>
282 <indexterm zone="libical libicalvcal">
283 <primary sortas="c-libicalvcal">libicalvcal.so</primary>
284 </indexterm>
285 </listitem>
286 </varlistentry>
287
288 </variablelist>
289
290 </sect2>
291
292</sect1>
Note: See TracBrowser for help on using the repository browser.