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 &&
|
---|
103 | cd build &&
|
---|
104 |
|
---|
105 | cmake -DCMAKE_INSTALL_PREFIX=/usr \
|
---|
106 | -DCMAKE_BUILD_TYPE=Release \
|
---|
107 | -DSHARED_ONLY=yes \
|
---|
108 | -DICAL_BUILD_DOCS=false \
|
---|
109 | .. &&
|
---|
110 | make</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 remap="doc"><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"
|
---|
140 | remap="doc"><userinput>install -vdm755 /usr/share/doc/libical-&libical-version;/html &&
|
---|
141 | cp -vr apidocs/html/* /usr/share/doc/libical-&libical-version;/html</userinput></screen>
|
---|
142 | -->
|
---|
143 | </sect2>
|
---|
144 |
|
---|
145 | <sect2 role="commands">
|
---|
146 | <title>Command Explanations</title>
|
---|
147 |
|
---|
148 | <para>
|
---|
149 | <parameter>-DCMAKE_BUILD_TYPE=Release</parameter>: This switch is used
|
---|
150 | to apply higher level of the compiler optimizations.
|
---|
151 | </para>
|
---|
152 |
|
---|
153 | <para>
|
---|
154 | <parameter>-DSHARED_ONLY=yes</parameter>: This switch is used
|
---|
155 | in order to only build the shared libraries.
|
---|
156 | </para>
|
---|
157 |
|
---|
158 | <para>
|
---|
159 | <parameter>-DICAL_BUILD_DOCS=false</parameter>: This switch prevents
|
---|
160 | building the <application>GTK</application> documentation, because
|
---|
161 | gtk-doc-1.30 is broken. Unfortunately, it also prevents building the
|
---|
162 | API documentation.
|
---|
163 | </para>
|
---|
164 |
|
---|
165 | <para>
|
---|
166 | <option>-DUSE_BUILTIN_TZDATA=yes</option>: This switch is used
|
---|
167 | in order to build using your own timezone data.
|
---|
168 | </para>
|
---|
169 |
|
---|
170 | <!-- No CMake equivalents
|
---|
171 | <para>
|
---|
172 | <parameter>- -enable-cxx</parameter>: This switch enables
|
---|
173 | <application>libical</application> C++ library.
|
---|
174 | </para>
|
---|
175 |
|
---|
176 | <para>
|
---|
177 | <option>- -enable-python</option>: This switch enables
|
---|
178 | <application>libical</application> Python bindings.
|
---|
179 | </para> -->
|
---|
180 |
|
---|
181 | </sect2>
|
---|
182 |
|
---|
183 | <sect2 role="content">
|
---|
184 | <title>Contents</title>
|
---|
185 |
|
---|
186 | <segmentedlist>
|
---|
187 | <segtitle>Installed Programs</segtitle>
|
---|
188 | <segtitle>Installed Libraries</segtitle>
|
---|
189 | <segtitle>Installed Directory</segtitle>
|
---|
190 |
|
---|
191 | <seglistitem>
|
---|
192 | <seg>
|
---|
193 | None
|
---|
194 | </seg>
|
---|
195 | <seg>
|
---|
196 | libical_cxx.so, libical.so, libicalss_cxx.so, libicalss.so,
|
---|
197 | and libicalvcal.so
|
---|
198 | </seg>
|
---|
199 | <seg>
|
---|
200 | /usr/include/libical, /usr/lib/cmake/LibIcal and
|
---|
201 | /usr/share/doc/libical-&libical-version;/html
|
---|
202 | </seg>
|
---|
203 | </seglistitem>
|
---|
204 | </segmentedlist>
|
---|
205 |
|
---|
206 | <variablelist>
|
---|
207 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
208 | <?dbfo list-presentation="list"?>
|
---|
209 | <?dbhtml list-presentation="table"?>
|
---|
210 |
|
---|
211 | <varlistentry id="libical-lib">
|
---|
212 | <term><filename class="libraryfile">libical.so</filename></term>
|
---|
213 | <listitem>
|
---|
214 | <para>
|
---|
215 | contains the <application>libical</application> API
|
---|
216 | functions.
|
---|
217 | </para>
|
---|
218 | <indexterm zone="libical libical-lib">
|
---|
219 | <primary sortas="c-libical">libical.so</primary>
|
---|
220 | </indexterm>
|
---|
221 | </listitem>
|
---|
222 | </varlistentry>
|
---|
223 |
|
---|
224 | <varlistentry id="libical_cxx-lib">
|
---|
225 | <term><filename class="libraryfile">libical_cxx.so</filename></term>
|
---|
226 | <listitem>
|
---|
227 | <para>
|
---|
228 | contains the <application>libical</application> C++ bindings.
|
---|
229 | </para>
|
---|
230 | <indexterm zone="libical libical_cxx-lib">
|
---|
231 | <primary sortas="c-libical_cxx">libical_cxx.so</primary>
|
---|
232 | </indexterm>
|
---|
233 | </listitem>
|
---|
234 | </varlistentry>
|
---|
235 |
|
---|
236 | <varlistentry id="libicalss">
|
---|
237 | <term><filename class="libraryfile">libicalss.so</filename></term>
|
---|
238 | <listitem>
|
---|
239 | <para>
|
---|
240 | is a library that allows you to store iCal component data
|
---|
241 | to disk in a variety of ways.
|
---|
242 | </para>
|
---|
243 | <indexterm zone="libical libicalss">
|
---|
244 | <primary sortas="c-libicalss">libicalss.so</primary>
|
---|
245 | </indexterm>
|
---|
246 | </listitem>
|
---|
247 | </varlistentry>
|
---|
248 |
|
---|
249 | <varlistentry id="libicalss_cxx">
|
---|
250 | <term><filename class="libraryfile">libicalss_cxx.so</filename></term>
|
---|
251 | <listitem>
|
---|
252 | <para>
|
---|
253 | contains the <application>libicalss</application> C++
|
---|
254 | bindings.
|
---|
255 | </para>
|
---|
256 | <indexterm zone="libical libicalss_cxx">
|
---|
257 | <primary sortas="c-libicalss_cxx">libicalss_cxx.so</primary>
|
---|
258 | </indexterm>
|
---|
259 | </listitem>
|
---|
260 | </varlistentry>
|
---|
261 |
|
---|
262 | <varlistentry id="libicalvcal">
|
---|
263 | <term><filename class="libraryfile">libicalvcal.so</filename></term>
|
---|
264 | <listitem>
|
---|
265 | <para>
|
---|
266 | is a vCard/vCalendar C interface.
|
---|
267 | </para>
|
---|
268 | <indexterm zone="libical libicalvcal">
|
---|
269 | <primary sortas="c-libicalvcal">libicalvcal.so</primary>
|
---|
270 | </indexterm>
|
---|
271 | </listitem>
|
---|
272 | </varlistentry>
|
---|
273 |
|
---|
274 | </variablelist>
|
---|
275 |
|
---|
276 | </sect2>
|
---|
277 |
|
---|
278 | </sect1>
|
---|