source: general/genlib/libical.xml@ 26602d7

10.0 10.1 11.0 11.1 11.2 9.0 9.1 lazarus plabs/python-mods qt5new trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since 26602d7 was 26602d7, checked in by Bruce Dubbs <bdubbs@…>, 4 years ago

Update to stunnel-5.54.
Update to libsoup-2.66.2.
Update to libical-3.0.5.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@21598 af4574ff-66df-0310-9fd7-8a98e5e911e0

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