[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[31bf432] | 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 " ">
|
---|
[9a3d519c] | 9 | <!ENTITY libical-md5sum "cc790ea49701df0335d42b89d57c04bc">
|
---|
[dd2202b2] | 10 | <!ENTITY libical-size "888 KB">
|
---|
[9a3d519c] | 11 | <!ENTITY libical-buildsize "24 MB (with tests)">
|
---|
[bca6ccc0] | 12 | <!ENTITY libical-time "0.1 SBU (using parallelism=4; with tests)">
|
---|
[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 |
|
---|
[fc87c5a0] | 34 | &lfs122_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">
|
---|
[c0bc0a9] | 80 | &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="doxygen"/> (for the API documentation),
|
---|
[113f4e6] | 87 | <xref linkend="graphviz"/> (for the API documentation),
|
---|
[ba768b1] | 88 | <xref linkend="gtk-doc"/> (for the API documentation),
|
---|
[dcd5a063] | 89 | <xref linkend="icu"/>,
|
---|
| 90 | <xref linkend="pygobject3"/> (for some tests), and
|
---|
| 91 | &berkeley-db;
|
---|
[131b1b7] | 92 | </para>
|
---|
| 93 |
|
---|
[31bf432] | 94 | </sect2>
|
---|
| 95 |
|
---|
| 96 | <sect2 role="installation">
|
---|
| 97 | <title>Installation of libical</title>
|
---|
| 98 |
|
---|
[0cbc592a] | 99 | <!-- https://github.com/libical/libical/pull/690 -->
|
---|
| 100 | <para>
|
---|
| 101 | If <xref linkend='icu'/> is installed, fix an incompatibility
|
---|
| 102 | with ICU 75 or later:
|
---|
| 103 | </para>
|
---|
| 104 |
|
---|
[ad8b716] | 105 | <screen><userinput>sed -i '/getKeywordValuesForLocale/s/NULL/""/' src/libical/icalrecur.c</userinput></screen>
|
---|
[0cbc592a] | 106 |
|
---|
[23d3543c] | 107 | <para>
|
---|
| 108 | Install <application>libical</application> by running the
|
---|
| 109 | following commands:
|
---|
| 110 | </para>
|
---|
[31bf432] | 111 |
|
---|
[aa41434] | 112 | <!-- Needs confirmation, but I got a race condition at -j8,
|
---|
[09794600] | 113 | -j1 allowed the build to pass. Pierre 2019-12-06
|
---|
[9a3d519c] | 114 | I always have it actually. Hence the entity.
|
---|
| 115 |
|
---|
| 116 | Works at -j8 and -j4 for version 3.0.18
|
---|
| 117 | ¶llel_issues;-->
|
---|
[22618785] | 118 | <screen><userinput>mkdir build &&
|
---|
| 119 | cd build &&
|
---|
| 120 |
|
---|
[9a3d519c] | 121 | cmake -D CMAKE_INSTALL_PREFIX=/usr \
|
---|
| 122 | -D CMAKE_BUILD_TYPE=Release \
|
---|
| 123 | -D SHARED_ONLY=yes \
|
---|
| 124 | -D ICAL_BUILD_DOCS=false \
|
---|
| 125 | -D ICAL_BUILD_EXAMPLES=false \
|
---|
| 126 | -D GOBJECT_INTROSPECTION=true \
|
---|
| 127 | -D ICAL_GLIB_VAPI=true \
|
---|
[23d3543c] | 128 | .. &&
|
---|
[9a3d519c] | 129 | make</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
|
---|
[93b67cd3] | 135 | remove the <parameter>-D ICAL_BUILD_DOCS=false</parameter> switch
|
---|
[113f4e6] | 136 | and issue:
|
---|
[131b1b7] | 137 | </para>
|
---|
| 138 |
|
---|
[a42c273] | 139 | <screen remap="doc"><userinput>make docs</userinput></screen>
|
---|
[ba768b1] | 140 |
|
---|
[0cbc592a] | 141 | <!-- https://github.com/libical/libical/pull/684
|
---|
| 142 | It looks like an ICU bug but I've not got time to investigate
|
---|
| 143 | carefully. -->
|
---|
[23d3543c] | 144 | <para>
|
---|
| 145 | To test the results, issue: <command>make test</command>.
|
---|
[0cbc592a] | 146 | One test named <literal>icalrecurtest-r</literal> is known to fail.
|
---|
[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>
|
---|
[9a3d519c] | 170 | <parameter>-D CMAKE_BUILD_TYPE=Release</parameter>: This switch is used
|
---|
[23d3543c] | 171 | to apply higher level of the compiler optimizations.
|
---|
| 172 | </para>
|
---|
[b2a4bc8] | 173 |
|
---|
[131b1b7] | 174 | <para>
|
---|
[9a3d519c] | 175 | <parameter>-D SHARED_ONLY=yes</parameter>: This switch is used
|
---|
[131b1b7] | 176 | in order to only build the shared libraries.
|
---|
| 177 | </para>
|
---|
| 178 |
|
---|
[07f61e4] | 179 | <para>
|
---|
[9a3d519c] | 180 | <parameter>-D ICAL_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>
|
---|
[9a3d519c] | 186 | <parameter>-D ICAL_BUILD_EXAMPLES=false</parameter>: This switch prevents
|
---|
| 187 | building examples. Remove if you want to build them.
|
---|
| 188 | </para>
|
---|
| 189 |
|
---|
| 190 | <para>
|
---|
| 191 | <parameter>-D GOBJECT_INTROSPECTION=true</parameter>: This switch is used
|
---|
[aa41434] | 192 | to generate GObject metadata bindings.
|
---|
[b1d3c72a] | 193 | </para>
|
---|
| 194 |
|
---|
[5d314e0] | 195 | <para>
|
---|
[9a3d519c] | 196 | <parameter>-D ICAL_GLIB_VAPI=true</parameter>: This switch is used
|
---|
[aa41434] | 197 | in order to build bindings for <xref linkend="vala"/>.
|
---|
[5d314e0] | 198 | </para>
|
---|
| 199 |
|
---|
| 200 | <para>
|
---|
[9a3d519c] | 201 | <option>-D USE_BUILTIN_TZDATA=yes</option>: This switch is used
|
---|
[aa41434] | 202 | in order to build using your own timezone data.
|
---|
[5d314e0] | 203 | </para>
|
---|
| 204 |
|
---|
[23d3543c] | 205 | <!-- No CMake equivalents
|
---|
| 206 | <para>
|
---|
| 207 | <parameter>- -enable-cxx</parameter>: This switch enables
|
---|
| 208 | <application>libical</application> C++ library.
|
---|
| 209 | </para>
|
---|
[b2a4bc8] | 210 |
|
---|
[23d3543c] | 211 | <para>
|
---|
| 212 | <option>- -enable-python</option>: This switch enables
|
---|
| 213 | <application>libical</application> Python bindings.
|
---|
| 214 | </para> -->
|
---|
[31bf432] | 215 |
|
---|
| 216 | </sect2>
|
---|
| 217 |
|
---|
| 218 | <sect2 role="content">
|
---|
| 219 | <title>Contents</title>
|
---|
| 220 |
|
---|
| 221 | <segmentedlist>
|
---|
| 222 | <segtitle>Installed Programs</segtitle>
|
---|
| 223 | <segtitle>Installed Libraries</segtitle>
|
---|
[23d3543c] | 224 | <segtitle>Installed Directory</segtitle>
|
---|
[31bf432] | 225 |
|
---|
| 226 | <seglistitem>
|
---|
[23d3543c] | 227 | <seg>
|
---|
| 228 | None
|
---|
| 229 | </seg>
|
---|
| 230 | <seg>
|
---|
[8558044] | 231 | libical_cxx.so,
|
---|
| 232 | libical.so,
|
---|
| 233 | libical-glib.so,
|
---|
| 234 | libicalss_cxx.so,
|
---|
[ba768b1] | 235 | libicalss.so,
|
---|
[b1d3c72a] | 236 | and libicalvcal.so
|
---|
[23d3543c] | 237 | </seg>
|
---|
| 238 | <seg>
|
---|
[8558044] | 239 | /usr/include/libical,
|
---|
| 240 | /usr/include/libical-glib,
|
---|
| 241 | /usr/lib/cmake/LibIcal,
|
---|
| 242 | /usr/libexec/libical,
|
---|
[113f4e6] | 243 | /usr/share/gtk-doc/html/libical-glib (optional),
|
---|
[ba768b1] | 244 | and /usr/share/doc/libical-&libical-version;/html
|
---|
[23d3543c] | 245 | </seg>
|
---|
[31bf432] | 246 | </seglistitem>
|
---|
| 247 | </segmentedlist>
|
---|
| 248 |
|
---|
| 249 | <variablelist>
|
---|
| 250 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 251 | <?dbfo list-presentation="list"?>
|
---|
| 252 | <?dbhtml list-presentation="table"?>
|
---|
| 253 |
|
---|
| 254 | <varlistentry id="libical-lib">
|
---|
[131b1b7] | 255 | <term><filename class="libraryfile">libical.so</filename></term>
|
---|
[31bf432] | 256 | <listitem>
|
---|
[23d3543c] | 257 | <para>
|
---|
| 258 | contains the <application>libical</application> API
|
---|
[4c24eb0a] | 259 | functions
|
---|
[23d3543c] | 260 | </para>
|
---|
[31bf432] | 261 | <indexterm zone="libical libical-lib">
|
---|
[131b1b7] | 262 | <primary sortas="c-libical">libical.so</primary>
|
---|
[31bf432] | 263 | </indexterm>
|
---|
| 264 | </listitem>
|
---|
| 265 | </varlistentry>
|
---|
| 266 |
|
---|
[b1d3c72a] | 267 | <varlistentry id="libical_cxx-lib">
|
---|
| 268 | <term><filename class="libraryfile">libical_cxx.so</filename></term>
|
---|
| 269 | <listitem>
|
---|
| 270 | <para>
|
---|
[4c24eb0a] | 271 | contains the <application>libical</application> C++ bindings
|
---|
[b1d3c72a] | 272 | </para>
|
---|
| 273 | <indexterm zone="libical libical_cxx-lib">
|
---|
| 274 | <primary sortas="c-libical_cxx">libical_cxx.so</primary>
|
---|
| 275 | </indexterm>
|
---|
| 276 | </listitem>
|
---|
| 277 | </varlistentry>
|
---|
| 278 |
|
---|
[ba768b1] | 279 | <varlistentry id="libical-glib">
|
---|
| 280 | <term><filename class="libraryfile">libical-glib.so</filename></term>
|
---|
| 281 | <listitem>
|
---|
| 282 | <para>
|
---|
[4c24eb0a] | 283 | contains the <application>libical</application> glib bindings
|
---|
[ba768b1] | 284 | </para>
|
---|
| 285 | <indexterm zone="libical libical-glib">
|
---|
| 286 | <primary sortas="c-libical-glib">libical-glib.so</primary>
|
---|
| 287 | </indexterm>
|
---|
| 288 | </listitem>
|
---|
| 289 | </varlistentry>
|
---|
| 290 |
|
---|
[31bf432] | 291 | <varlistentry id="libicalss">
|
---|
[131b1b7] | 292 | <term><filename class="libraryfile">libicalss.so</filename></term>
|
---|
[31bf432] | 293 | <listitem>
|
---|
[23d3543c] | 294 | <para>
|
---|
[c4b0455] | 295 | is a library that allows you to store iCal component data
|
---|
[4c24eb0a] | 296 | to disk in a variety of ways
|
---|
[23d3543c] | 297 | </para>
|
---|
[31bf432] | 298 | <indexterm zone="libical libicalss">
|
---|
[131b1b7] | 299 | <primary sortas="c-libicalss">libicalss.so</primary>
|
---|
[31bf432] | 300 | </indexterm>
|
---|
| 301 | </listitem>
|
---|
| 302 | </varlistentry>
|
---|
| 303 |
|
---|
[b1d3c72a] | 304 | <varlistentry id="libicalss_cxx">
|
---|
| 305 | <term><filename class="libraryfile">libicalss_cxx.so</filename></term>
|
---|
| 306 | <listitem>
|
---|
| 307 | <para>
|
---|
| 308 | contains the <application>libicalss</application> C++
|
---|
[4c24eb0a] | 309 | bindings
|
---|
[b1d3c72a] | 310 | </para>
|
---|
| 311 | <indexterm zone="libical libicalss_cxx">
|
---|
| 312 | <primary sortas="c-libicalss_cxx">libicalss_cxx.so</primary>
|
---|
| 313 | </indexterm>
|
---|
| 314 | </listitem>
|
---|
| 315 | </varlistentry>
|
---|
| 316 |
|
---|
[31bf432] | 317 | <varlistentry id="libicalvcal">
|
---|
[131b1b7] | 318 | <term><filename class="libraryfile">libicalvcal.so</filename></term>
|
---|
[31bf432] | 319 | <listitem>
|
---|
[23d3543c] | 320 | <para>
|
---|
[4c24eb0a] | 321 | is a vCard/vCalendar C interface
|
---|
[23d3543c] | 322 | </para>
|
---|
[31bf432] | 323 | <indexterm zone="libical libicalvcal">
|
---|
[131b1b7] | 324 | <primary sortas="c-libicalvcal">libicalvcal.so</primary>
|
---|
[31bf432] | 325 | </indexterm>
|
---|
| 326 | </listitem>
|
---|
| 327 | </varlistentry>
|
---|
| 328 |
|
---|
| 329 | </variablelist>
|
---|
| 330 |
|
---|
| 331 | </sect2>
|
---|
| 332 |
|
---|
| 333 | </sect1>
|
---|