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