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