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