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