source: general/genlib/libidl.xml@ 27d0323

<?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 libidl-download-http "&gnome-download-http;/libIDL/0.8/libIDL-&libidl-version;.tar.bz2">
  <!ENTITY libidl-download-ftp  "&gnome-download-ftp;/libIDL/0.8/libIDL-&libidl-version;.tar.bz2">
  <!ENTITY libidl-md5sum        "bb8e10a218fac793a52d404d14adedcb">
  <!ENTITY libidl-size          "417 KB">
  <!ENTITY libidl-buildsize     "5 MB">
  <!ENTITY libidl-time          "0.1 SBU">
]>

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

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

  <title>LibIDL-&libidl-version;</title>

  <indexterm zone="libidl">
    <primary sortas="a-LibIDL">LibIDL</primary>
  </indexterm>

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

    <para>The <application>libIDL</application> package
    contains libraries for Interface Definition Language files. This is a
    specification for defining portable interfaces.</para>

    &lfs65_checked;

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

    <bridgehead renderas="sect3">LibIDL Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="glib2"/> and
    <xref linkend="pkgconfig"/></para>

    <bridgehead renderas="sect4">Optional to Build Documentation</bridgehead>
    <para role="optional"><!-- <xref linkend="tetex"/> or -->
    <xref linkend="texlive"/></para>

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

  </sect2>

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

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

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

makeinfo --plaintext -o libIDL2.txt libIDL2.texi</userinput></screen>

    <para>If you have <application>teTeX</application> or
    <application>Live TeX</application> installed and wish to
    build alternate forms of the documentation, issue the following
    command:</para>

<screen><userinput>make pdf ps</userinput></screen>

    <para>This package does not come with a test suite.</para>

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

<screen role="root"><userinput>make install

install -v -m755 -d /usr/share/doc/libIDL-&libidl-version; &amp;&amp;
install -v -m644    README libIDL2.{txt,texi} \
                    /usr/share/doc/libIDL-&libidl-version;</userinput></screen>

    <para>If you built the additional documentation, issue the following
    command as the <systemitem class="username">root</systemitem> user to
    install it:</para>

<screen role="root"><userinput>install -v -m644 libIDL2.{pdf,dvi,ps} \
                 /usr/share/doc/libIDL-&libidl-version;</userinput></screen>
  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>libIDL-config-2</seg>
        <seg>libIDL-2.{so,a}</seg>
        <seg>/usr/include/libIDL-2.0/libIDL and
        /usr/share/doc/libIDL-&libidl-version;</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libIDL-config-2">
        <term><command>libIDL-config-2</command></term>
        <listitem>
          <para>determines the compile and linker flags that should be used to
          compile and link programs that use
          <filename class="libraryfile">libIDL-2</filename>.</para>
          <indexterm zone="libidl libIDL-config-2">
            <primary sortas="b-libIDL-config-2">libIDL-config-2</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libIDL-2">
        <term><filename class="libraryfile">libIDL-2.{so,a}</filename></term>
        <listitem>
          <para>libraries provide the functions to create and maintain
          trees of CORBA Interface Definition Language
          (IDL) files.</para>
          <indexterm zone="libidl libIDL-2">
            <primary sortas="c-libIDL-2">libIDL-2.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>