[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)">
|
---|
| 12 | <!ENTITY libical-time "0.1 SBU (iusing 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 |
|
---|
[181e069f] | 34 | &lfs121_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 |
|
---|
[23d3543c] | 99 | <para>
|
---|
| 100 | Install <application>libical</application> by running the
|
---|
| 101 | following commands:
|
---|
| 102 | </para>
|
---|
[31bf432] | 103 |
|
---|
[aa41434] | 104 | <!-- Needs confirmation, but I got a race condition at -j8,
|
---|
[09794600] | 105 | -j1 allowed the build to pass. Pierre 2019-12-06
|
---|
[9a3d519c] | 106 | I always have it actually. Hence the entity.
|
---|
| 107 |
|
---|
| 108 | Works at -j8 and -j4 for version 3.0.18
|
---|
| 109 | ¶llel_issues;-->
|
---|
[22618785] | 110 | <screen><userinput>mkdir build &&
|
---|
| 111 | cd build &&
|
---|
| 112 |
|
---|
[9a3d519c] | 113 | cmake -D CMAKE_INSTALL_PREFIX=/usr \
|
---|
| 114 | -D CMAKE_BUILD_TYPE=Release \
|
---|
| 115 | -D SHARED_ONLY=yes \
|
---|
| 116 | -D ICAL_BUILD_DOCS=false \
|
---|
| 117 | -D ICAL_BUILD_EXAMPLES=false \
|
---|
| 118 | -D GOBJECT_INTROSPECTION=true \
|
---|
| 119 | -D ICAL_GLIB_VAPI=true \
|
---|
[23d3543c] | 120 | .. &&
|
---|
[9a3d519c] | 121 | make</userinput></screen>
|
---|
[ba768b1] | 122 |
|
---|
[131b1b7] | 123 | <para>
|
---|
[113f4e6] | 124 | If you have <xref linkend="doxygen"/>, <xref linkend="graphviz"/>,
|
---|
| 125 | and <xref linkend="gtk-doc"/>
|
---|
| 126 | installed and wish to build the API documentation, you should
|
---|
| 127 | remove the <parameter>-DICAL_BUILD_DOCS=false</parameter> switch
|
---|
| 128 | and issue:
|
---|
[131b1b7] | 129 | </para>
|
---|
| 130 |
|
---|
[a42c273] | 131 | <screen remap="doc"><userinput>make docs</userinput></screen>
|
---|
[ba768b1] | 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. -->
|
---|
[8558044] | 136 | <!-- On systemd, we symlink the current timezone to
|
---|
| 137 | /etc/localtime, which is what libical expects.
|
---|
[1588ff1] | 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>
|
---|
[ba768b1] | 146 |
|
---|
[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>
|
---|
[ba768b1] | 155 |
|
---|
[31bf432] | 156 | </sect2>
|
---|
| 157 |
|
---|
| 158 | <sect2 role="commands">
|
---|
| 159 | <title>Command Explanations</title>
|
---|
| 160 |
|
---|
[23d3543c] | 161 | <para>
|
---|
[9a3d519c] | 162 | <parameter>-D CMAKE_BUILD_TYPE=Release</parameter>: This switch is used
|
---|
[23d3543c] | 163 | to apply higher level of the compiler optimizations.
|
---|
| 164 | </para>
|
---|
[b2a4bc8] | 165 |
|
---|
[131b1b7] | 166 | <para>
|
---|
[9a3d519c] | 167 | <parameter>-D SHARED_ONLY=yes</parameter>: This switch is used
|
---|
[131b1b7] | 168 | in order to only build the shared libraries.
|
---|
| 169 | </para>
|
---|
| 170 |
|
---|
[07f61e4] | 171 | <para>
|
---|
[9a3d519c] | 172 | <parameter>-D ICAL_BUILD_DOCS=false</parameter>: This switch prevents
|
---|
[113f4e6] | 173 | building the <application>GTK</application> documentation. Remove
|
---|
| 174 | if you want to build the documentation.
|
---|
[07f61e4] | 175 | </para>
|
---|
| 176 |
|
---|
[b1d3c72a] | 177 | <para>
|
---|
[9a3d519c] | 178 | <parameter>-D ICAL_BUILD_EXAMPLES=false</parameter>: This switch prevents
|
---|
| 179 | building examples. Remove if you want to build them.
|
---|
| 180 | </para>
|
---|
| 181 |
|
---|
| 182 | <para>
|
---|
| 183 | <parameter>-D GOBJECT_INTROSPECTION=true</parameter>: This switch is used
|
---|
[aa41434] | 184 | to generate GObject metadata bindings.
|
---|
[b1d3c72a] | 185 | </para>
|
---|
| 186 |
|
---|
[5d314e0] | 187 | <para>
|
---|
[9a3d519c] | 188 | <parameter>-D ICAL_GLIB_VAPI=true</parameter>: This switch is used
|
---|
[aa41434] | 189 | in order to build bindings for <xref linkend="vala"/>.
|
---|
[5d314e0] | 190 | </para>
|
---|
| 191 |
|
---|
| 192 | <para>
|
---|
[9a3d519c] | 193 | <option>-D USE_BUILTIN_TZDATA=yes</option>: This switch is used
|
---|
[aa41434] | 194 | in order to build using your own timezone data.
|
---|
[5d314e0] | 195 | </para>
|
---|
| 196 |
|
---|
[23d3543c] | 197 | <!-- No CMake equivalents
|
---|
| 198 | <para>
|
---|
| 199 | <parameter>- -enable-cxx</parameter>: This switch enables
|
---|
| 200 | <application>libical</application> C++ library.
|
---|
| 201 | </para>
|
---|
[b2a4bc8] | 202 |
|
---|
[23d3543c] | 203 | <para>
|
---|
| 204 | <option>- -enable-python</option>: This switch enables
|
---|
| 205 | <application>libical</application> Python bindings.
|
---|
| 206 | </para> -->
|
---|
[31bf432] | 207 |
|
---|
| 208 | </sect2>
|
---|
| 209 |
|
---|
| 210 | <sect2 role="content">
|
---|
| 211 | <title>Contents</title>
|
---|
| 212 |
|
---|
| 213 | <segmentedlist>
|
---|
| 214 | <segtitle>Installed Programs</segtitle>
|
---|
| 215 | <segtitle>Installed Libraries</segtitle>
|
---|
[23d3543c] | 216 | <segtitle>Installed Directory</segtitle>
|
---|
[31bf432] | 217 |
|
---|
| 218 | <seglistitem>
|
---|
[23d3543c] | 219 | <seg>
|
---|
| 220 | None
|
---|
| 221 | </seg>
|
---|
| 222 | <seg>
|
---|
[8558044] | 223 | libical_cxx.so,
|
---|
| 224 | libical.so,
|
---|
| 225 | libical-glib.so,
|
---|
| 226 | libicalss_cxx.so,
|
---|
[ba768b1] | 227 | libicalss.so,
|
---|
[b1d3c72a] | 228 | and libicalvcal.so
|
---|
[23d3543c] | 229 | </seg>
|
---|
| 230 | <seg>
|
---|
[8558044] | 231 | /usr/include/libical,
|
---|
| 232 | /usr/include/libical-glib,
|
---|
| 233 | /usr/lib/cmake/LibIcal,
|
---|
| 234 | /usr/libexec/libical,
|
---|
[113f4e6] | 235 | /usr/share/gtk-doc/html/libical-glib (optional),
|
---|
[ba768b1] | 236 | and /usr/share/doc/libical-&libical-version;/html
|
---|
[23d3543c] | 237 | </seg>
|
---|
[31bf432] | 238 | </seglistitem>
|
---|
| 239 | </segmentedlist>
|
---|
| 240 |
|
---|
| 241 | <variablelist>
|
---|
| 242 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 243 | <?dbfo list-presentation="list"?>
|
---|
| 244 | <?dbhtml list-presentation="table"?>
|
---|
| 245 |
|
---|
| 246 | <varlistentry id="libical-lib">
|
---|
[131b1b7] | 247 | <term><filename class="libraryfile">libical.so</filename></term>
|
---|
[31bf432] | 248 | <listitem>
|
---|
[23d3543c] | 249 | <para>
|
---|
| 250 | contains the <application>libical</application> API
|
---|
[4c24eb0a] | 251 | functions
|
---|
[23d3543c] | 252 | </para>
|
---|
[31bf432] | 253 | <indexterm zone="libical libical-lib">
|
---|
[131b1b7] | 254 | <primary sortas="c-libical">libical.so</primary>
|
---|
[31bf432] | 255 | </indexterm>
|
---|
| 256 | </listitem>
|
---|
| 257 | </varlistentry>
|
---|
| 258 |
|
---|
[b1d3c72a] | 259 | <varlistentry id="libical_cxx-lib">
|
---|
| 260 | <term><filename class="libraryfile">libical_cxx.so</filename></term>
|
---|
| 261 | <listitem>
|
---|
| 262 | <para>
|
---|
[4c24eb0a] | 263 | contains the <application>libical</application> C++ bindings
|
---|
[b1d3c72a] | 264 | </para>
|
---|
| 265 | <indexterm zone="libical libical_cxx-lib">
|
---|
| 266 | <primary sortas="c-libical_cxx">libical_cxx.so</primary>
|
---|
| 267 | </indexterm>
|
---|
| 268 | </listitem>
|
---|
| 269 | </varlistentry>
|
---|
| 270 |
|
---|
[ba768b1] | 271 | <varlistentry id="libical-glib">
|
---|
| 272 | <term><filename class="libraryfile">libical-glib.so</filename></term>
|
---|
| 273 | <listitem>
|
---|
| 274 | <para>
|
---|
[4c24eb0a] | 275 | contains the <application>libical</application> glib bindings
|
---|
[ba768b1] | 276 | </para>
|
---|
| 277 | <indexterm zone="libical libical-glib">
|
---|
| 278 | <primary sortas="c-libical-glib">libical-glib.so</primary>
|
---|
| 279 | </indexterm>
|
---|
| 280 | </listitem>
|
---|
| 281 | </varlistentry>
|
---|
| 282 |
|
---|
[31bf432] | 283 | <varlistentry id="libicalss">
|
---|
[131b1b7] | 284 | <term><filename class="libraryfile">libicalss.so</filename></term>
|
---|
[31bf432] | 285 | <listitem>
|
---|
[23d3543c] | 286 | <para>
|
---|
[c4b0455] | 287 | is a library that allows you to store iCal component data
|
---|
[4c24eb0a] | 288 | to disk in a variety of ways
|
---|
[23d3543c] | 289 | </para>
|
---|
[31bf432] | 290 | <indexterm zone="libical libicalss">
|
---|
[131b1b7] | 291 | <primary sortas="c-libicalss">libicalss.so</primary>
|
---|
[31bf432] | 292 | </indexterm>
|
---|
| 293 | </listitem>
|
---|
| 294 | </varlistentry>
|
---|
| 295 |
|
---|
[b1d3c72a] | 296 | <varlistentry id="libicalss_cxx">
|
---|
| 297 | <term><filename class="libraryfile">libicalss_cxx.so</filename></term>
|
---|
| 298 | <listitem>
|
---|
| 299 | <para>
|
---|
| 300 | contains the <application>libicalss</application> C++
|
---|
[4c24eb0a] | 301 | bindings
|
---|
[b1d3c72a] | 302 | </para>
|
---|
| 303 | <indexterm zone="libical libicalss_cxx">
|
---|
| 304 | <primary sortas="c-libicalss_cxx">libicalss_cxx.so</primary>
|
---|
| 305 | </indexterm>
|
---|
| 306 | </listitem>
|
---|
| 307 | </varlistentry>
|
---|
| 308 |
|
---|
[31bf432] | 309 | <varlistentry id="libicalvcal">
|
---|
[131b1b7] | 310 | <term><filename class="libraryfile">libicalvcal.so</filename></term>
|
---|
[31bf432] | 311 | <listitem>
|
---|
[23d3543c] | 312 | <para>
|
---|
[4c24eb0a] | 313 | is a vCard/vCalendar C interface
|
---|
[23d3543c] | 314 | </para>
|
---|
[31bf432] | 315 | <indexterm zone="libical libicalvcal">
|
---|
[131b1b7] | 316 | <primary sortas="c-libicalvcal">libicalvcal.so</primary>
|
---|
[31bf432] | 317 | </indexterm>
|
---|
| 318 | </listitem>
|
---|
| 319 | </varlistentry>
|
---|
| 320 |
|
---|
| 321 | </variablelist>
|
---|
| 322 |
|
---|
| 323 | </sect2>
|
---|
| 324 |
|
---|
| 325 | </sect1>
|
---|