[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 " ">
|
---|
[39d331b] | 9 | <!ENTITY libical-md5sum "8a5d07a7fba9e73a85e67f76258bf042">
|
---|
| 10 | <!ENTITY libical-size "864 KB">
|
---|
| 11 | <!ENTITY libical-buildsize "24 MB (with tests)">
|
---|
[0ec2262] | 12 | <!ENTITY libical-time "0.2 SBU (Using parallelism=5; with tests)">
|
---|
[31bf432] | 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 |
|
---|
[23d3543c] | 32 | <para>
|
---|
| 33 | The <application>libical</application> package contains an implementation
|
---|
| 34 | of the iCalendar protocols and data formats.
|
---|
| 35 | </para>
|
---|
[31bf432] | 36 |
|
---|
[ad112fd5] | 37 | &lfs90_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">
|
---|
| 83 | <xref linkend="gobject-introspection"/> and
|
---|
| 84 | <xref linkend="vala"/>(both required for Gnome)
|
---|
| 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),
|
---|
[aa41434] | 91 | <xref linkend="icu"/>
|
---|
[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 |
|
---|
[23d3543c] | 102 | <para>
|
---|
| 103 | Install <application>libical</application> by running the
|
---|
| 104 | following commands:
|
---|
| 105 | </para>
|
---|
[31bf432] | 106 |
|
---|
[23d3543c] | 107 | <screen><userinput>mkdir build &&
|
---|
[c0ee00e] | 108 | cd build &&
|
---|
[18c9ee54] | 109 |
|
---|
[aa41434] | 110 | <!-- Needs confirmation, but I got a race condition at -j8,
|
---|
| 111 | -j1 allowed the build to pass. Pierre 2019-12-06 -->
|
---|
| 112 |
|
---|
[5d314e0] | 113 | cmake -DCMAKE_INSTALL_PREFIX=/usr \
|
---|
| 114 | -DCMAKE_BUILD_TYPE=Release \
|
---|
| 115 | -DSHARED_ONLY=yes \
|
---|
| 116 | -DICAL_BUILD_DOCS=false \
|
---|
| 117 | -DGOBJECT_INTROSPECTION=true \
|
---|
| 118 | -DICAL_GLIB_VAPI=true \
|
---|
[23d3543c] | 119 | .. &&
|
---|
[31bf432] | 120 | make</userinput></screen>
|
---|
[07f61e4] | 121 | <!-- DEVS: the ICAL_BUILD_DOCS=false switch is needed because gtk-doc-1.30 is
|
---|
| 122 | broken. Unfortunately, it also prevents running make docs. When gtk-doc
|
---|
| 123 | is fixed, remove the switch and uncomment this.
|
---|
[131b1b7] | 124 | <para>
|
---|
| 125 | If you have <xref linkend="doxygen"/> installed and wish to build the API
|
---|
| 126 | documentation, issue:
|
---|
| 127 | </para>
|
---|
| 128 |
|
---|
[a42c273] | 129 | <screen remap="doc"><userinput>make docs</userinput></screen>
|
---|
[07f61e4] | 130 | -->
|
---|
[23d3543c] | 131 | <para>
|
---|
| 132 | To test the results, issue: <command>make test</command>.
|
---|
[1588ff1] | 133 | <!-- One test, timezones, is known to fail on SysV systems. -->
|
---|
[b5e5d59] | 134 | <!-- On systemd, we symlink the current timezone to
|
---|
[1588ff1] | 135 | /etc/localtime, which is what libical expects.
|
---|
| 136 | This is now done on SysV as well.-->
|
---|
[23d3543c] | 137 | </para>
|
---|
[31bf432] | 138 |
|
---|
[23d3543c] | 139 | <para>
|
---|
| 140 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 141 | </para>
|
---|
[31bf432] | 142 |
|
---|
[23d3543c] | 143 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[07f61e4] | 144 | <!-- see above:
|
---|
[131b1b7] | 145 | <para>
|
---|
| 146 | If you have built the API documentation, install by issuing, as
|
---|
| 147 | <systemitem class="username">root</systemitem> user:
|
---|
| 148 | </para>
|
---|
| 149 |
|
---|
[a42c273] | 150 | <screen role="root"
|
---|
| 151 | remap="doc"><userinput>install -vdm755 /usr/share/doc/libical-&libical-version;/html &&
|
---|
[131b1b7] | 152 | cp -vr apidocs/html/* /usr/share/doc/libical-&libical-version;/html</userinput></screen>
|
---|
[07f61e4] | 153 | -->
|
---|
[31bf432] | 154 | </sect2>
|
---|
| 155 |
|
---|
| 156 | <sect2 role="commands">
|
---|
| 157 | <title>Command Explanations</title>
|
---|
| 158 |
|
---|
[23d3543c] | 159 | <para>
|
---|
| 160 | <parameter>-DCMAKE_BUILD_TYPE=Release</parameter>: This switch is used
|
---|
| 161 | to apply higher level of the compiler optimizations.
|
---|
| 162 | </para>
|
---|
[b2a4bc8] | 163 |
|
---|
[131b1b7] | 164 | <para>
|
---|
| 165 | <parameter>-DSHARED_ONLY=yes</parameter>: This switch is used
|
---|
| 166 | in order to only build the shared libraries.
|
---|
| 167 | </para>
|
---|
| 168 |
|
---|
[07f61e4] | 169 | <para>
|
---|
| 170 | <parameter>-DICAL_BUILD_DOCS=false</parameter>: This switch prevents
|
---|
| 171 | building the <application>GTK</application> documentation, because
|
---|
| 172 | gtk-doc-1.30 is broken. Unfortunately, it also prevents building the
|
---|
| 173 | API documentation.
|
---|
| 174 | </para>
|
---|
| 175 |
|
---|
[b1d3c72a] | 176 | <para>
|
---|
[aa41434] | 177 | <parameter>-DGOBJECT_INTROSPECTION=true</parameter>: This switch is used
|
---|
| 178 | to generate GObject metadata bindings.
|
---|
[b1d3c72a] | 179 | </para>
|
---|
| 180 |
|
---|
[5d314e0] | 181 | <para>
|
---|
[aa41434] | 182 | <parameter>-DICAL_GLIB_VAPI=true</parameter>: This switch is used
|
---|
| 183 | in order to build bindings for <xref linkend="vala"/>.
|
---|
[5d314e0] | 184 | </para>
|
---|
| 185 |
|
---|
| 186 | <para>
|
---|
[aa41434] | 187 | <option>-DUSE_BUILTIN_TZDATA=yes</option>: This switch is used
|
---|
| 188 | in order to build using your own timezone data.
|
---|
[5d314e0] | 189 | </para>
|
---|
| 190 |
|
---|
[23d3543c] | 191 | <!-- No CMake equivalents
|
---|
| 192 | <para>
|
---|
| 193 | <parameter>- -enable-cxx</parameter>: This switch enables
|
---|
| 194 | <application>libical</application> C++ library.
|
---|
| 195 | </para>
|
---|
[b2a4bc8] | 196 |
|
---|
[23d3543c] | 197 | <para>
|
---|
| 198 | <option>- -enable-python</option>: This switch enables
|
---|
| 199 | <application>libical</application> Python bindings.
|
---|
| 200 | </para> -->
|
---|
[31bf432] | 201 |
|
---|
| 202 | </sect2>
|
---|
| 203 |
|
---|
| 204 | <sect2 role="content">
|
---|
| 205 | <title>Contents</title>
|
---|
| 206 |
|
---|
| 207 | <segmentedlist>
|
---|
| 208 | <segtitle>Installed Programs</segtitle>
|
---|
| 209 | <segtitle>Installed Libraries</segtitle>
|
---|
[23d3543c] | 210 | <segtitle>Installed Directory</segtitle>
|
---|
[31bf432] | 211 |
|
---|
| 212 | <seglistitem>
|
---|
[23d3543c] | 213 | <seg>
|
---|
| 214 | None
|
---|
| 215 | </seg>
|
---|
| 216 | <seg>
|
---|
[b1d3c72a] | 217 | libical_cxx.so, libical.so, libicalss_cxx.so, libicalss.so,
|
---|
| 218 | and libicalvcal.so
|
---|
[23d3543c] | 219 | </seg>
|
---|
| 220 | <seg>
|
---|
[b1d3c72a] | 221 | /usr/include/libical, /usr/lib/cmake/LibIcal and
|
---|
[131b1b7] | 222 | /usr/share/doc/libical-&libical-version;/html
|
---|
[23d3543c] | 223 | </seg>
|
---|
[31bf432] | 224 | </seglistitem>
|
---|
| 225 | </segmentedlist>
|
---|
| 226 |
|
---|
| 227 | <variablelist>
|
---|
| 228 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 229 | <?dbfo list-presentation="list"?>
|
---|
| 230 | <?dbhtml list-presentation="table"?>
|
---|
| 231 |
|
---|
| 232 | <varlistentry id="libical-lib">
|
---|
[131b1b7] | 233 | <term><filename class="libraryfile">libical.so</filename></term>
|
---|
[31bf432] | 234 | <listitem>
|
---|
[23d3543c] | 235 | <para>
|
---|
| 236 | contains the <application>libical</application> API
|
---|
| 237 | functions.
|
---|
| 238 | </para>
|
---|
[31bf432] | 239 | <indexterm zone="libical libical-lib">
|
---|
[131b1b7] | 240 | <primary sortas="c-libical">libical.so</primary>
|
---|
[31bf432] | 241 | </indexterm>
|
---|
| 242 | </listitem>
|
---|
| 243 | </varlistentry>
|
---|
| 244 |
|
---|
[b1d3c72a] | 245 | <varlistentry id="libical_cxx-lib">
|
---|
| 246 | <term><filename class="libraryfile">libical_cxx.so</filename></term>
|
---|
| 247 | <listitem>
|
---|
| 248 | <para>
|
---|
| 249 | contains the <application>libical</application> C++ bindings.
|
---|
| 250 | </para>
|
---|
| 251 | <indexterm zone="libical libical_cxx-lib">
|
---|
| 252 | <primary sortas="c-libical_cxx">libical_cxx.so</primary>
|
---|
| 253 | </indexterm>
|
---|
| 254 | </listitem>
|
---|
| 255 | </varlistentry>
|
---|
| 256 |
|
---|
[31bf432] | 257 | <varlistentry id="libicalss">
|
---|
[131b1b7] | 258 | <term><filename class="libraryfile">libicalss.so</filename></term>
|
---|
[31bf432] | 259 | <listitem>
|
---|
[23d3543c] | 260 | <para>
|
---|
[c4b0455] | 261 | is a library that allows you to store iCal component data
|
---|
[23d3543c] | 262 | to disk in a variety of ways.
|
---|
| 263 | </para>
|
---|
[31bf432] | 264 | <indexterm zone="libical libicalss">
|
---|
[131b1b7] | 265 | <primary sortas="c-libicalss">libicalss.so</primary>
|
---|
[31bf432] | 266 | </indexterm>
|
---|
| 267 | </listitem>
|
---|
| 268 | </varlistentry>
|
---|
| 269 |
|
---|
[b1d3c72a] | 270 | <varlistentry id="libicalss_cxx">
|
---|
| 271 | <term><filename class="libraryfile">libicalss_cxx.so</filename></term>
|
---|
| 272 | <listitem>
|
---|
| 273 | <para>
|
---|
| 274 | contains the <application>libicalss</application> C++
|
---|
| 275 | bindings.
|
---|
| 276 | </para>
|
---|
| 277 | <indexterm zone="libical libicalss_cxx">
|
---|
| 278 | <primary sortas="c-libicalss_cxx">libicalss_cxx.so</primary>
|
---|
| 279 | </indexterm>
|
---|
| 280 | </listitem>
|
---|
| 281 | </varlistentry>
|
---|
| 282 |
|
---|
[31bf432] | 283 | <varlistentry id="libicalvcal">
|
---|
[131b1b7] | 284 | <term><filename class="libraryfile">libicalvcal.so</filename></term>
|
---|
[31bf432] | 285 | <listitem>
|
---|
[23d3543c] | 286 | <para>
|
---|
| 287 | is a vCard/vCalendar C interface.
|
---|
| 288 | </para>
|
---|
[31bf432] | 289 | <indexterm zone="libical libicalvcal">
|
---|
[131b1b7] | 290 | <primary sortas="c-libicalvcal">libicalvcal.so</primary>
|
---|
[31bf432] | 291 | </indexterm>
|
---|
| 292 | </listitem>
|
---|
| 293 | </varlistentry>
|
---|
| 294 |
|
---|
| 295 | </variablelist>
|
---|
| 296 |
|
---|
| 297 | </sect2>
|
---|
| 298 |
|
---|
| 299 | </sect1>
|
---|