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