[31bf432] | 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 |
|
---|
[8dfc5c3] | 7 | <!ENTITY libical-download-http "https://github.com/libical/libical/releases/download/v&libical-version;/libical-&libical-version;.tar.gz">
|
---|
[31bf432] | 8 | <!ENTITY libical-download-ftp " ">
|
---|
[b4ca8bb] | 9 | <!ENTITY libical-md5sum "8dc988c2fa957ee04337e77b15de0718">
|
---|
| 10 | <!ENTITY libical-size "868 KB">
|
---|
| 11 | <!ENTITY libical-buildsize "24 MB (with tests and API documentation)">
|
---|
| 12 | <!ENTITY libical-time "0.3 SBU (with tests and documentation)">
|
---|
[113f4e6] | 13 | <!-- run at -j1 because it fails at -j4 -->
|
---|
[31bf432] | 14 | ]>
|
---|
| 15 |
|
---|
| 16 | <sect1 id="libical" xreflabel="libical-&libical-version;">
|
---|
| 17 | <?dbhtml filename="libical.html"?>
|
---|
| 18 |
|
---|
| 19 | <sect1info>
|
---|
| 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 |
|
---|
[23d3543c] | 32 | <para>
|
---|
| 33 | The <application>libical</application> package contains an implementation
|
---|
| 34 | of the iCalendar protocols and data formats.
|
---|
| 35 | </para>
|
---|
[31bf432] | 36 |
|
---|
[03a2986] | 37 | &lfs111_checked;
|
---|
[df46eec] | 38 |
|
---|
[31bf432] | 39 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
[010bb600] | 40 |
|
---|
[31bf432] | 41 | <itemizedlist spacing="compact">
|
---|
| 42 | <listitem>
|
---|
[23d3543c] | 43 | <para>
|
---|
| 44 | Download (HTTP): <ulink url="&libical-download-http;"/>
|
---|
| 45 | </para>
|
---|
[31bf432] | 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
[23d3543c] | 48 | <para>
|
---|
| 49 | Download (FTP): <ulink url="&libical-download-ftp;"/>
|
---|
| 50 | </para>
|
---|
[31bf432] | 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
[23d3543c] | 53 | <para>
|
---|
| 54 | Download MD5 sum: &libical-md5sum;
|
---|
| 55 | </para>
|
---|
[31bf432] | 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
[23d3543c] | 58 | <para>
|
---|
| 59 | Download size: &libical-size;
|
---|
| 60 | </para>
|
---|
[31bf432] | 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
[23d3543c] | 63 | <para>
|
---|
| 64 | Estimated disk space required: &libical-buildsize;
|
---|
| 65 | </para>
|
---|
[31bf432] | 66 | </listitem>
|
---|
| 67 | <listitem>
|
---|
[23d3543c] | 68 | <para>
|
---|
| 69 | Estimated build time: &libical-time;
|
---|
| 70 | </para>
|
---|
[31bf432] | 71 | </listitem>
|
---|
| 72 | </itemizedlist>
|
---|
| 73 |
|
---|
| 74 | <bridgehead renderas="sect3">libical Dependencies</bridgehead>
|
---|
| 75 |
|
---|
[23d3543c] | 76 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 77 | <para role="required">
|
---|
| 78 | <xref linkend="cmake"/>
|
---|
| 79 | </para>
|
---|
| 80 |
|
---|
[aa41434] | 81 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 82 | <para role="recommended">
|
---|
[8558044] | 83 | <xref linkend="gobject-introspection"/> and
|
---|
[e9b9a70] | 84 | <xref linkend="vala"/> (both required for GNOME)
|
---|
[aa41434] | 85 | </para>
|
---|
| 86 |
|
---|
[131b1b7] | 87 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 88 | <para role="optional">
|
---|
[b1d3c72a] | 89 | <xref linkend="db"/>,
|
---|
| 90 | <xref linkend="doxygen"/> (for the API documentation),
|
---|
[113f4e6] | 91 | <xref linkend="graphviz"/> (for the API documentation),
|
---|
[ba768b1] | 92 | <xref linkend="gtk-doc"/> (for the API documentation),
|
---|
[d3dab74f] | 93 | <xref linkend="icu"/>, and
|
---|
| 94 | <xref linkend="pygobject3"/> (for some tests)
|
---|
[131b1b7] | 95 | </para>
|
---|
| 96 |
|
---|
[31bf432] | 97 | <para condition="html" role="usernotes">User Notes:
|
---|
[23d3543c] | 98 | <ulink url="&blfs-wiki;/libical"/>
|
---|
| 99 | </para>
|
---|
[31bf432] | 100 | </sect2>
|
---|
| 101 |
|
---|
| 102 | <sect2 role="installation">
|
---|
| 103 | <title>Installation of libical</title>
|
---|
| 104 |
|
---|
[ba768b1] | 105 | <!-- Not needed with 3.0.9
|
---|
[481fd21] | 106 | <para>First make some fixes for the latest versions of icu and Python:</para>
|
---|
| 107 |
|
---|
| 108 | <screen><userinput>sed -i '/define LEAP_MONTH/a #define FALSE 0' src/libical/icalrecur.c &&
|
---|
| 109 | sed -i 's/array/arraytest/' src/test/libical-glib/CMakeLists.txt &&
|
---|
| 110 | mv src/test/libical-glib/array.py src/test/libical-glib/arraytest.py</userinput></screen>
|
---|
[ba768b1] | 111 | -->
|
---|
[481fd21] | 112 |
|
---|
[23d3543c] | 113 | <para>
|
---|
| 114 | Install <application>libical</application> by running the
|
---|
| 115 | following commands:
|
---|
| 116 | </para>
|
---|
[31bf432] | 117 |
|
---|
[aa41434] | 118 | <!-- Needs confirmation, but I got a race condition at -j8,
|
---|
[09794600] | 119 | -j1 allowed the build to pass. Pierre 2019-12-06
|
---|
| 120 | I always have it actually. Hence the entity.-->
|
---|
| 121 | ¶llel_issues;
|
---|
[22618785] | 122 | <screen><userinput>mkdir build &&
|
---|
| 123 | cd build &&
|
---|
| 124 |
|
---|
[5d314e0] | 125 | cmake -DCMAKE_INSTALL_PREFIX=/usr \
|
---|
| 126 | -DCMAKE_BUILD_TYPE=Release \
|
---|
| 127 | -DSHARED_ONLY=yes \
|
---|
| 128 | -DICAL_BUILD_DOCS=false \
|
---|
| 129 | -DGOBJECT_INTROSPECTION=true \
|
---|
| 130 | -DICAL_GLIB_VAPI=true \
|
---|
[23d3543c] | 131 | .. &&
|
---|
[a0df6ac] | 132 | make -j1</userinput></screen>
|
---|
[ba768b1] | 133 |
|
---|
[131b1b7] | 134 | <para>
|
---|
[113f4e6] | 135 | If you have <xref linkend="doxygen"/>, <xref linkend="graphviz"/>,
|
---|
| 136 | and <xref linkend="gtk-doc"/>
|
---|
| 137 | installed and wish to build the API documentation, you should
|
---|
| 138 | remove the <parameter>-DICAL_BUILD_DOCS=false</parameter> switch
|
---|
| 139 | and issue:
|
---|
[131b1b7] | 140 | </para>
|
---|
| 141 |
|
---|
[a42c273] | 142 | <screen remap="doc"><userinput>make docs</userinput></screen>
|
---|
[ba768b1] | 143 |
|
---|
[23d3543c] | 144 | <para>
|
---|
| 145 | To test the results, issue: <command>make test</command>.
|
---|
[1588ff1] | 146 | <!-- One test, timezones, is known to fail on SysV systems. -->
|
---|
[8558044] | 147 | <!-- On systemd, we symlink the current timezone to
|
---|
| 148 | /etc/localtime, which is what libical expects.
|
---|
[1588ff1] | 149 | This is now done on SysV as well.-->
|
---|
[23d3543c] | 150 | </para>
|
---|
[31bf432] | 151 |
|
---|
[23d3543c] | 152 | <para>
|
---|
| 153 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 154 | </para>
|
---|
[31bf432] | 155 |
|
---|
[23d3543c] | 156 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[ba768b1] | 157 |
|
---|
[131b1b7] | 158 | <para>
|
---|
| 159 | If you have built the API documentation, install by issuing, as
|
---|
| 160 | <systemitem class="username">root</systemitem> user:
|
---|
| 161 | </para>
|
---|
| 162 |
|
---|
[a42c273] | 163 | <screen role="root"
|
---|
| 164 | remap="doc"><userinput>install -vdm755 /usr/share/doc/libical-&libical-version;/html &&
|
---|
[131b1b7] | 165 | cp -vr apidocs/html/* /usr/share/doc/libical-&libical-version;/html</userinput></screen>
|
---|
[ba768b1] | 166 |
|
---|
[31bf432] | 167 | </sect2>
|
---|
| 168 |
|
---|
| 169 | <sect2 role="commands">
|
---|
| 170 | <title>Command Explanations</title>
|
---|
| 171 |
|
---|
[23d3543c] | 172 | <para>
|
---|
| 173 | <parameter>-DCMAKE_BUILD_TYPE=Release</parameter>: This switch is used
|
---|
| 174 | to apply higher level of the compiler optimizations.
|
---|
| 175 | </para>
|
---|
[b2a4bc8] | 176 |
|
---|
[131b1b7] | 177 | <para>
|
---|
| 178 | <parameter>-DSHARED_ONLY=yes</parameter>: This switch is used
|
---|
| 179 | in order to only build the shared libraries.
|
---|
| 180 | </para>
|
---|
| 181 |
|
---|
[07f61e4] | 182 | <para>
|
---|
| 183 | <parameter>-DICAL_BUILD_DOCS=false</parameter>: This switch prevents
|
---|
[113f4e6] | 184 | building the <application>GTK</application> documentation. Remove
|
---|
| 185 | if you want to build the documentation.
|
---|
[07f61e4] | 186 | </para>
|
---|
| 187 |
|
---|
[b1d3c72a] | 188 | <para>
|
---|
[aa41434] | 189 | <parameter>-DGOBJECT_INTROSPECTION=true</parameter>: This switch is used
|
---|
| 190 | to generate GObject metadata bindings.
|
---|
[b1d3c72a] | 191 | </para>
|
---|
| 192 |
|
---|
[5d314e0] | 193 | <para>
|
---|
[aa41434] | 194 | <parameter>-DICAL_GLIB_VAPI=true</parameter>: This switch is used
|
---|
| 195 | in order to build bindings for <xref linkend="vala"/>.
|
---|
[5d314e0] | 196 | </para>
|
---|
| 197 |
|
---|
| 198 | <para>
|
---|
[aa41434] | 199 | <option>-DUSE_BUILTIN_TZDATA=yes</option>: This switch is used
|
---|
| 200 | in order to build using your own timezone data.
|
---|
[5d314e0] | 201 | </para>
|
---|
| 202 |
|
---|
[23d3543c] | 203 | <!-- No CMake equivalents
|
---|
| 204 | <para>
|
---|
| 205 | <parameter>- -enable-cxx</parameter>: This switch enables
|
---|
| 206 | <application>libical</application> C++ library.
|
---|
| 207 | </para>
|
---|
[b2a4bc8] | 208 |
|
---|
[23d3543c] | 209 | <para>
|
---|
| 210 | <option>- -enable-python</option>: This switch enables
|
---|
| 211 | <application>libical</application> Python bindings.
|
---|
| 212 | </para> -->
|
---|
[31bf432] | 213 |
|
---|
| 214 | </sect2>
|
---|
| 215 |
|
---|
| 216 | <sect2 role="content">
|
---|
| 217 | <title>Contents</title>
|
---|
| 218 |
|
---|
| 219 | <segmentedlist>
|
---|
| 220 | <segtitle>Installed Programs</segtitle>
|
---|
| 221 | <segtitle>Installed Libraries</segtitle>
|
---|
[23d3543c] | 222 | <segtitle>Installed Directory</segtitle>
|
---|
[31bf432] | 223 |
|
---|
| 224 | <seglistitem>
|
---|
[23d3543c] | 225 | <seg>
|
---|
| 226 | None
|
---|
| 227 | </seg>
|
---|
| 228 | <seg>
|
---|
[8558044] | 229 | libical_cxx.so,
|
---|
| 230 | libical.so,
|
---|
| 231 | libical-glib.so,
|
---|
| 232 | libicalss_cxx.so,
|
---|
[ba768b1] | 233 | libicalss.so,
|
---|
[b1d3c72a] | 234 | and libicalvcal.so
|
---|
[23d3543c] | 235 | </seg>
|
---|
| 236 | <seg>
|
---|
[8558044] | 237 | /usr/include/libical,
|
---|
| 238 | /usr/include/libical-glib,
|
---|
| 239 | /usr/lib/cmake/LibIcal,
|
---|
| 240 | /usr/libexec/libical,
|
---|
[113f4e6] | 241 | /usr/share/gtk-doc/html/libical-glib (optional),
|
---|
[ba768b1] | 242 | and /usr/share/doc/libical-&libical-version;/html
|
---|
[23d3543c] | 243 | </seg>
|
---|
[31bf432] | 244 | </seglistitem>
|
---|
| 245 | </segmentedlist>
|
---|
| 246 |
|
---|
| 247 | <variablelist>
|
---|
| 248 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 249 | <?dbfo list-presentation="list"?>
|
---|
| 250 | <?dbhtml list-presentation="table"?>
|
---|
| 251 |
|
---|
| 252 | <varlistentry id="libical-lib">
|
---|
[131b1b7] | 253 | <term><filename class="libraryfile">libical.so</filename></term>
|
---|
[31bf432] | 254 | <listitem>
|
---|
[23d3543c] | 255 | <para>
|
---|
| 256 | contains the <application>libical</application> API
|
---|
[4c24eb0a] | 257 | functions
|
---|
[23d3543c] | 258 | </para>
|
---|
[31bf432] | 259 | <indexterm zone="libical libical-lib">
|
---|
[131b1b7] | 260 | <primary sortas="c-libical">libical.so</primary>
|
---|
[31bf432] | 261 | </indexterm>
|
---|
| 262 | </listitem>
|
---|
| 263 | </varlistentry>
|
---|
| 264 |
|
---|
[b1d3c72a] | 265 | <varlistentry id="libical_cxx-lib">
|
---|
| 266 | <term><filename class="libraryfile">libical_cxx.so</filename></term>
|
---|
| 267 | <listitem>
|
---|
| 268 | <para>
|
---|
[4c24eb0a] | 269 | contains the <application>libical</application> C++ bindings
|
---|
[b1d3c72a] | 270 | </para>
|
---|
| 271 | <indexterm zone="libical libical_cxx-lib">
|
---|
| 272 | <primary sortas="c-libical_cxx">libical_cxx.so</primary>
|
---|
| 273 | </indexterm>
|
---|
| 274 | </listitem>
|
---|
| 275 | </varlistentry>
|
---|
| 276 |
|
---|
[ba768b1] | 277 | <varlistentry id="libical-glib">
|
---|
| 278 | <term><filename class="libraryfile">libical-glib.so</filename></term>
|
---|
| 279 | <listitem>
|
---|
| 280 | <para>
|
---|
[4c24eb0a] | 281 | contains the <application>libical</application> glib bindings
|
---|
[ba768b1] | 282 | </para>
|
---|
| 283 | <indexterm zone="libical libical-glib">
|
---|
| 284 | <primary sortas="c-libical-glib">libical-glib.so</primary>
|
---|
| 285 | </indexterm>
|
---|
| 286 | </listitem>
|
---|
| 287 | </varlistentry>
|
---|
| 288 |
|
---|
[31bf432] | 289 | <varlistentry id="libicalss">
|
---|
[131b1b7] | 290 | <term><filename class="libraryfile">libicalss.so</filename></term>
|
---|
[31bf432] | 291 | <listitem>
|
---|
[23d3543c] | 292 | <para>
|
---|
[c4b0455] | 293 | is a library that allows you to store iCal component data
|
---|
[4c24eb0a] | 294 | to disk in a variety of ways
|
---|
[23d3543c] | 295 | </para>
|
---|
[31bf432] | 296 | <indexterm zone="libical libicalss">
|
---|
[131b1b7] | 297 | <primary sortas="c-libicalss">libicalss.so</primary>
|
---|
[31bf432] | 298 | </indexterm>
|
---|
| 299 | </listitem>
|
---|
| 300 | </varlistentry>
|
---|
| 301 |
|
---|
[b1d3c72a] | 302 | <varlistentry id="libicalss_cxx">
|
---|
| 303 | <term><filename class="libraryfile">libicalss_cxx.so</filename></term>
|
---|
| 304 | <listitem>
|
---|
| 305 | <para>
|
---|
| 306 | contains the <application>libicalss</application> C++
|
---|
[4c24eb0a] | 307 | bindings
|
---|
[b1d3c72a] | 308 | </para>
|
---|
| 309 | <indexterm zone="libical libicalss_cxx">
|
---|
| 310 | <primary sortas="c-libicalss_cxx">libicalss_cxx.so</primary>
|
---|
| 311 | </indexterm>
|
---|
| 312 | </listitem>
|
---|
| 313 | </varlistentry>
|
---|
| 314 |
|
---|
[31bf432] | 315 | <varlistentry id="libicalvcal">
|
---|
[131b1b7] | 316 | <term><filename class="libraryfile">libicalvcal.so</filename></term>
|
---|
[31bf432] | 317 | <listitem>
|
---|
[23d3543c] | 318 | <para>
|
---|
[4c24eb0a] | 319 | is a vCard/vCalendar C interface
|
---|
[23d3543c] | 320 | </para>
|
---|
[31bf432] | 321 | <indexterm zone="libical libicalvcal">
|
---|
[131b1b7] | 322 | <primary sortas="c-libicalvcal">libicalvcal.so</primary>
|
---|
[31bf432] | 323 | </indexterm>
|
---|
| 324 | </listitem>
|
---|
| 325 | </varlistentry>
|
---|
| 326 |
|
---|
| 327 | </variablelist>
|
---|
| 328 |
|
---|
| 329 | </sect2>
|
---|
| 330 |
|
---|
| 331 | </sect1>
|
---|