[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 " ">
|
---|
[b1d3c72a] | 9 | <!ENTITY libical-md5sum "6bf8e5f5a3ba88baf390d0134e05d76e">
|
---|
| 10 | <!ENTITY libical-size "684 KB">
|
---|
| 11 | <!ENTITY libical-buildsize "14 MB, with tests (additional 12 MB for the API documentation)">
|
---|
[0e107e3] | 12 | <!ENTITY libical-time "0.3 SBU (with tests and API documentation)">
|
---|
[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 |
|
---|
[35e9ca45] | 37 | &lfs81_checked;
|
---|
[df46eec] | 38 |
|
---|
[31bf432] | 39 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
[969ae5b] | 40 | <!--
|
---|
[0969339] | 41 | <note>
|
---|
| 42 |
|
---|
| 43 | <para>The download link below obtains
|
---|
| 44 | <filename>libical-&libical-version;.tar.gz</filename> if a web browser
|
---|
[2354b23] | 45 | such as <xref linkend="firefox"/> is used. This is the correct name
|
---|
[0969339] | 46 | for the archive, because it saves the file as <filename
|
---|
| 47 | class="directory">libical-&libical-version;</filename>. However, if
|
---|
| 48 | another method is used for downloading, e.g. <xref linkend="wget"/>, the
|
---|
| 49 | file name is <filename>v&libical-version;.tar.gz</filename>, which is not
|
---|
| 50 | acceptable. The file should be renamed to the correct filename
|
---|
| 51 | <filename>libical-&libical-version;.tar.gz</filename>. You can achieve
|
---|
| 52 | this automatically by using the command:</para>
|
---|
[f3429309] | 53 |
|
---|
[0969339] | 54 | <screen><userinput>wget <ulink url="&libical-download-http;"/> -O libical-&libical-version;.tar.gz</userinput></screen>
|
---|
| 55 | </note>
|
---|
[969ae5b] | 56 | -->
|
---|
[31bf432] | 57 | <itemizedlist spacing="compact">
|
---|
| 58 | <listitem>
|
---|
[23d3543c] | 59 | <para>
|
---|
| 60 | Download (HTTP): <ulink url="&libical-download-http;"/>
|
---|
| 61 | </para>
|
---|
[31bf432] | 62 | </listitem>
|
---|
| 63 | <listitem>
|
---|
[23d3543c] | 64 | <para>
|
---|
| 65 | Download (FTP): <ulink url="&libical-download-ftp;"/>
|
---|
| 66 | </para>
|
---|
[31bf432] | 67 | </listitem>
|
---|
| 68 | <listitem>
|
---|
[23d3543c] | 69 | <para>
|
---|
| 70 | Download MD5 sum: &libical-md5sum;
|
---|
| 71 | </para>
|
---|
[31bf432] | 72 | </listitem>
|
---|
| 73 | <listitem>
|
---|
[23d3543c] | 74 | <para>
|
---|
| 75 | Download size: &libical-size;
|
---|
| 76 | </para>
|
---|
[31bf432] | 77 | </listitem>
|
---|
| 78 | <listitem>
|
---|
[23d3543c] | 79 | <para>
|
---|
| 80 | Estimated disk space required: &libical-buildsize;
|
---|
| 81 | </para>
|
---|
[31bf432] | 82 | </listitem>
|
---|
| 83 | <listitem>
|
---|
[23d3543c] | 84 | <para>
|
---|
| 85 | Estimated build time: &libical-time;
|
---|
| 86 | </para>
|
---|
[31bf432] | 87 | </listitem>
|
---|
| 88 | </itemizedlist>
|
---|
| 89 |
|
---|
| 90 | <bridgehead renderas="sect3">libical Dependencies</bridgehead>
|
---|
| 91 |
|
---|
[23d3543c] | 92 | <!-- Upstream recommends to use CMake since autotools
|
---|
| 93 | doesn't bump soname for 0.48 -> 1.0 incompatibility -->
|
---|
| 94 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 95 | <para role="required">
|
---|
| 96 | <xref linkend="cmake"/>
|
---|
| 97 | </para>
|
---|
| 98 |
|
---|
[131b1b7] | 99 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 100 | <para role="optional">
|
---|
[b1d3c72a] | 101 | <xref linkend="db"/>,
|
---|
| 102 | <xref linkend="doxygen"/> (for the API documentation),
|
---|
| 103 | <xref linkend="gobject-introspection"/>, and
|
---|
| 104 | <xref linkend="icu"/>
|
---|
[131b1b7] | 105 | </para>
|
---|
| 106 |
|
---|
[23d3543c] | 107 | <!-- Can't be built using CMake
|
---|
[31bf432] | 108 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[23d3543c] | 109 | <para role="optional">
|
---|
| 110 | <xref linkend="openjdk"/> and
|
---|
[7dfb8c9] | 111 | <xref linkend="python2"/> (must have <xref linkend="swig"/> also)
|
---|
[23d3543c] | 112 | </para> -->
|
---|
[31bf432] | 113 |
|
---|
| 114 | <para condition="html" role="usernotes">User Notes:
|
---|
[23d3543c] | 115 | <ulink url="&blfs-wiki;/libical"/>
|
---|
| 116 | </para>
|
---|
[31bf432] | 117 | </sect2>
|
---|
| 118 |
|
---|
| 119 | <sect2 role="installation">
|
---|
| 120 | <title>Installation of libical</title>
|
---|
| 121 |
|
---|
[23d3543c] | 122 | <para>
|
---|
| 123 | Install <application>libical</application> by running the
|
---|
| 124 | following commands:
|
---|
| 125 | </para>
|
---|
[31bf432] | 126 |
|
---|
[23d3543c] | 127 | <screen><userinput>mkdir build &&
|
---|
| 128 | cd build &&
|
---|
[18c9ee54] | 129 |
|
---|
[92245989] | 130 | cmake -DCMAKE_INSTALL_PREFIX=/usr \
|
---|
| 131 | -DCMAKE_BUILD_TYPE=Release \
|
---|
| 132 | -DSHARED_ONLY=yes \
|
---|
[23d3543c] | 133 | .. &&
|
---|
[31bf432] | 134 | make</userinput></screen>
|
---|
| 135 |
|
---|
[131b1b7] | 136 | <para>
|
---|
| 137 | If you have <xref linkend="doxygen"/> installed and wish to build the API
|
---|
| 138 | documentation, issue:
|
---|
| 139 | </para>
|
---|
| 140 |
|
---|
| 141 | <screen><userinput>make docs</userinput></screen>
|
---|
| 142 |
|
---|
[23d3543c] | 143 | <para>
|
---|
| 144 | To test the results, issue: <command>make test</command>.
|
---|
| 145 | </para>
|
---|
[31bf432] | 146 |
|
---|
[23d3543c] | 147 | <para>
|
---|
| 148 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 149 | </para>
|
---|
[31bf432] | 150 |
|
---|
[23d3543c] | 151 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[31bf432] | 152 |
|
---|
[131b1b7] | 153 | <para>
|
---|
| 154 | If you have built the API documentation, install by issuing, as
|
---|
| 155 | <systemitem class="username">root</systemitem> user:
|
---|
| 156 | </para>
|
---|
| 157 |
|
---|
| 158 | <screen role="root"><userinput>install -vdm755 /usr/share/doc/libical-&libical-version;/html &&
|
---|
| 159 | cp -vr apidocs/html/* /usr/share/doc/libical-&libical-version;/html</userinput></screen>
|
---|
| 160 |
|
---|
[31bf432] | 161 | </sect2>
|
---|
| 162 |
|
---|
| 163 | <sect2 role="commands">
|
---|
| 164 | <title>Command Explanations</title>
|
---|
| 165 |
|
---|
[23d3543c] | 166 | <para>
|
---|
| 167 | <parameter>-DCMAKE_BUILD_TYPE=Release</parameter>: This switch is used
|
---|
| 168 | to apply higher level of the compiler optimizations.
|
---|
| 169 | </para>
|
---|
[b2a4bc8] | 170 |
|
---|
[131b1b7] | 171 | <para>
|
---|
| 172 | <parameter>-DSHARED_ONLY=yes</parameter>: This switch is used
|
---|
| 173 | in order to only build the shared libraries.
|
---|
| 174 | </para>
|
---|
| 175 |
|
---|
[b1d3c72a] | 176 | <para>
|
---|
| 177 | <option>-DUSE_BUILTIN_TZDATA=yes</option>: This switch is used
|
---|
| 178 | in order to build using your own timezone data.
|
---|
| 179 | </para>
|
---|
| 180 |
|
---|
[23d3543c] | 181 | <!-- No CMake equivalents
|
---|
| 182 | <para>
|
---|
| 183 | <parameter>- -enable-cxx</parameter>: This switch enables
|
---|
| 184 | <application>libical</application> C++ library.
|
---|
| 185 | </para>
|
---|
[b2a4bc8] | 186 |
|
---|
[23d3543c] | 187 | <para>
|
---|
| 188 | <option>- -enable-python</option>: This switch enables
|
---|
| 189 | <application>libical</application> Python bindings.
|
---|
| 190 | </para> -->
|
---|
[31bf432] | 191 |
|
---|
| 192 | </sect2>
|
---|
| 193 |
|
---|
| 194 | <sect2 role="content">
|
---|
| 195 | <title>Contents</title>
|
---|
| 196 |
|
---|
| 197 | <segmentedlist>
|
---|
| 198 | <segtitle>Installed Programs</segtitle>
|
---|
| 199 | <segtitle>Installed Libraries</segtitle>
|
---|
[23d3543c] | 200 | <segtitle>Installed Directory</segtitle>
|
---|
[31bf432] | 201 |
|
---|
| 202 | <seglistitem>
|
---|
[23d3543c] | 203 | <seg>
|
---|
| 204 | None
|
---|
| 205 | </seg>
|
---|
| 206 | <seg>
|
---|
[b1d3c72a] | 207 | libical_cxx.so, libical.so, libicalss_cxx.so, libicalss.so,
|
---|
| 208 | and libicalvcal.so
|
---|
[23d3543c] | 209 | </seg>
|
---|
| 210 | <seg>
|
---|
[b1d3c72a] | 211 | /usr/include/libical, /usr/lib/cmake/LibIcal and
|
---|
[131b1b7] | 212 | /usr/share/doc/libical-&libical-version;/html
|
---|
[23d3543c] | 213 | </seg>
|
---|
[31bf432] | 214 | </seglistitem>
|
---|
| 215 | </segmentedlist>
|
---|
| 216 |
|
---|
| 217 | <variablelist>
|
---|
| 218 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 219 | <?dbfo list-presentation="list"?>
|
---|
| 220 | <?dbhtml list-presentation="table"?>
|
---|
| 221 |
|
---|
| 222 | <varlistentry id="libical-lib">
|
---|
[131b1b7] | 223 | <term><filename class="libraryfile">libical.so</filename></term>
|
---|
[31bf432] | 224 | <listitem>
|
---|
[23d3543c] | 225 | <para>
|
---|
| 226 | contains the <application>libical</application> API
|
---|
| 227 | functions.
|
---|
| 228 | </para>
|
---|
[31bf432] | 229 | <indexterm zone="libical libical-lib">
|
---|
[131b1b7] | 230 | <primary sortas="c-libical">libical.so</primary>
|
---|
[31bf432] | 231 | </indexterm>
|
---|
| 232 | </listitem>
|
---|
| 233 | </varlistentry>
|
---|
| 234 |
|
---|
[b1d3c72a] | 235 | <varlistentry id="libical_cxx-lib">
|
---|
| 236 | <term><filename class="libraryfile">libical_cxx.so</filename></term>
|
---|
| 237 | <listitem>
|
---|
| 238 | <para>
|
---|
| 239 | contains the <application>libical</application> C++ bindings.
|
---|
| 240 | </para>
|
---|
| 241 | <indexterm zone="libical libical_cxx-lib">
|
---|
| 242 | <primary sortas="c-libical_cxx">libical_cxx.so</primary>
|
---|
| 243 | </indexterm>
|
---|
| 244 | </listitem>
|
---|
| 245 | </varlistentry>
|
---|
| 246 |
|
---|
[31bf432] | 247 | <varlistentry id="libicalss">
|
---|
[131b1b7] | 248 | <term><filename class="libraryfile">libicalss.so</filename></term>
|
---|
[31bf432] | 249 | <listitem>
|
---|
[23d3543c] | 250 | <para>
|
---|
[c4b0455] | 251 | is a library that allows you to store iCal component data
|
---|
[23d3543c] | 252 | to disk in a variety of ways.
|
---|
| 253 | </para>
|
---|
[31bf432] | 254 | <indexterm zone="libical libicalss">
|
---|
[131b1b7] | 255 | <primary sortas="c-libicalss">libicalss.so</primary>
|
---|
[31bf432] | 256 | </indexterm>
|
---|
| 257 | </listitem>
|
---|
| 258 | </varlistentry>
|
---|
| 259 |
|
---|
[b1d3c72a] | 260 | <varlistentry id="libicalss_cxx">
|
---|
| 261 | <term><filename class="libraryfile">libicalss_cxx.so</filename></term>
|
---|
| 262 | <listitem>
|
---|
| 263 | <para>
|
---|
| 264 | contains the <application>libicalss</application> C++
|
---|
| 265 | bindings.
|
---|
| 266 | </para>
|
---|
| 267 | <indexterm zone="libical libicalss_cxx">
|
---|
| 268 | <primary sortas="c-libicalss_cxx">libicalss_cxx.so</primary>
|
---|
| 269 | </indexterm>
|
---|
| 270 | </listitem>
|
---|
| 271 | </varlistentry>
|
---|
| 272 |
|
---|
[31bf432] | 273 | <varlistentry id="libicalvcal">
|
---|
[131b1b7] | 274 | <term><filename class="libraryfile">libicalvcal.so</filename></term>
|
---|
[31bf432] | 275 | <listitem>
|
---|
[23d3543c] | 276 | <para>
|
---|
| 277 | is a vCard/vCalendar C interface.
|
---|
| 278 | </para>
|
---|
[31bf432] | 279 | <indexterm zone="libical libicalvcal">
|
---|
[131b1b7] | 280 | <primary sortas="c-libicalvcal">libicalvcal.so</primary>
|
---|
[31bf432] | 281 | </indexterm>
|
---|
| 282 | </listitem>
|
---|
| 283 | </varlistentry>
|
---|
| 284 |
|
---|
| 285 | </variablelist>
|
---|
| 286 |
|
---|
| 287 | </sect2>
|
---|
| 288 |
|
---|
| 289 | </sect1>
|
---|