source: gnome/core/orbit2.xml@ 51d7b70

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

  <!ENTITY ORBit2-download-http "http://ftp.gnome.org/pub/GNOME/sources/ORBit2/&gnome-version;/ORBit2-&ORBit2-version;.tar.bz2">
  <!ENTITY ORBit2-download-ftp  "ftp://ftp.gnome.org/pub/GNOME/sources/ORBit2/&gnome-version;/ORBit2-&ORBit2-version;.tar.bz2">
  <!ENTITY ORBit2-md5sum        "aa2cae6e7957c369edccbd98ba78dea9">
  <!ENTITY ORBit2-size          "676 KB">
  <!ENTITY ORBit2-buildsize     "32.3 MB">
  <!ENTITY ORBit2-time          "0.7 SBU (additional 0.2 SBU to run the test suite)">
]>

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

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

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

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

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

    <para>The <application>ORBit2</application> package contains a
    high-performance CORBA Object Request Broker. This allows programs
    to send requests and receive replies from other programs.</para>

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para><xref linkend="libidl"/> and <xref linkend="popt"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para><xref linkend="gtk-doc"/> and <xref linkend="openssl"/></para>

  </sect2>

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

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

<screen><userinput>./configure --prefix=$GNOME_PREFIX --sysconfdir=/etc/gnome &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</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para><parameter>--prefix=$GNOME_PREFIX</parameter>: This is the base
    installation for <application>GNOME-2</application> from which all future
    package installations will receive their prefix parameter. Be sure that
    <envar>GNOME_PREFIX</envar> is set for this install or globally to your
    install directory as described in the introduction of this Chapter.</para>

    <para><parameter>--sysconfdir=/etc/gnome</parameter>: This switch puts
    configuration files in <filename class="directory">/etc/gnome</filename>
    instead of <filename class="directory">$GNOME_PREFIX/etc</filename>.</para>

    <para><option>--enable-gtk-doc</option>: Use this parameter if you have
    <application>GTK-Doc</application> installed and you wish to build the
    documentation.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>ior-decode-2, linc-cleanup-sockets, orbit-idl-2,
        orbit2-config and typelib-dump</seg>
        <seg>libname-server-2.a, libORBit-2.[so,a], libORBit-imodule-2.[so,a],
        libORBitCosNaming-2.[so,a], and Everything_module.[so,a]</seg>
        <seg>$GNOME_PREFIX/include/orbit-2.0,
        $GNOME_PREFIX/lib/orbit-2.0,
        $GNOME_PREFIX/share/gtk-doc/html/ORBit2,
        and $GNOME_PREFIX/share/idl/orbit-2.0</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libORBit-2">
        <term><filename class='libraryfile'>libORBit-2.[so,a]</filename></term>
        <listitem>
          <para>is the CORBA API.</para>
          <indexterm zone="ORBit2 libORBit-2">
            <primary sortas="c-libORBit-2">libORBit-2.[so,a]</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>