source: general/genlib/libical.xml@ b2a4bc8

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY libical-download-http "http://downloads.sourceforge.net/freeassociation/libical-&libical-version;.tar.gz">
  <!ENTITY libical-download-ftp  " ">
  <!ENTITY libical-md5sum        "e549f434d5fbf9cd156c60ed4943618f">
  <!ENTITY libical-size          "1.1 MB">
  <!ENTITY libical-buildsize     "56 MB">
  <!ENTITY libical-time          "0.5 SBU">
]>

<sect1 id="libical" xreflabel="libical-&libical-version;">
  <?dbhtml filename="libical.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>libical-&libical-version;</title>

  <indexterm zone="libical">
    <primary sortas="a-libical">libical</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to libical</title>

    <para>The <application>libical</application> package is an implementation of
    iCalendar protocols and data formats.</para>

    &lfs72_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&libical-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&libical-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &libical-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &libical-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &libical-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &libical-time;</para>
      </listitem>
    </itemizedlist>

    <!-- There is no support for the current version of BLFS BDB -->
    <bridgehead renderas="sect3">libical Dependencies</bridgehead>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <!-- <para role="optional"><xref linkend="db"/></para> -->
    <para role="optional"><xref linkend="python2"/> (must have
    <ulink url="http://www.swig.org/">SWIG</ulink> also)</para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/libical"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of libical</title>

    <para>Install <application>libical</application> by running the following
    commands:</para>

<screen><userinput>./configure --prefix=/usr --enable-cxx &amp;&amp;
make</userinput></screen>

    <para>To test the results, issue: <command>make check</command>.</para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make install &amp;&amp;
install -v -m755 -d /usr/share/doc/libical-&libical-version; &amp;&amp;
install -v -m644    README doc/{Adding,Using}*.txt \
                    /usr/share/doc/libical-&libical-version;</userinput></screen>

  </sect2>

  <!--  There is no support for the current version of BLFS BDB -->
  <sect2 role="commands">
    <title>Command Explanations</title>

    <!-- <para><option>-with-bdb4</option>: This option adds support for
    <application>Berkeley DB 4.0</application>.</para> -->

    <para><parameter>--enable-cxx</parameter>: This parameter builds C++
    <application>libical</application> library bindings.</para>

    <para><option>--enable-python</option>: This option builds Python
    <application>libical</application> bindings.</para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>None</seg>
        <seg>libical{,_cxx}.{so,a}, libicalss{,_cxx}.{so,a}, libicalvcal.{so,a},
        and (optionally) the Python _LibicalWrap.{so,a} modules</seg>
        <seg>/usr/include/libical and /usr/share/doc/libical-&libical-version;</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="libical-lib">
        <term><filename class='libraryfile'>libical.{so,a}</filename></term>
        <listitem>
          <para>contains the <application>libical</application> API
          functions.</para>
          <indexterm zone="libical libical-lib">
            <primary sortas="c-libical">libical.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libicalss">
        <term><filename class='libraryfile'>libicalss.{so,a}</filename></term>
        <listitem>
          <para>is a libary that allows you to store iCal component data to disk
          in a variety of ways.</para>
          <indexterm zone="libical libicalss">
            <primary sortas="c-libicalss">libicalss.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libicalvcal">
        <term><filename class='libraryfile'>libicalvcal.{so,a}</filename></term>
        <listitem>
          <para>is a vCard/vCalendar C interface.</para>
          <indexterm zone="libical libicalvcal">
            <primary sortas="c-libicalvcal">libicalvcal.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>