source: general/graphlib/fribidi.xml@ b3067411

<?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 fribidi-download-http "http://fribidi.org/download/fribidi-&fribidi-version;.tar.gz">
  <!ENTITY fribidi-download-ftp  " ">
  <!ENTITY fribidi-md5sum        "647aee89079b056269ff0918dc1c6d28">
  <!ENTITY fribidi-size          "607 KB">
  <!ENTITY fribidi-buildsize     "4.6 MB (without static library)">
  <!ENTITY fribidi-time          "Less than 0.1 SBU">
]>

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

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

  <title>FriBidi-&fribidi-version;</title>

  <indexterm zone="fribidi">
    <primary sortas="a-FriBidi">FriBidi</primary>
  </indexterm>

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

    <para>The <application>FriBidi</application> package is an implementation
    of the <ulink url="http://www.unicode.org/reports/tr9/">Unicode
    Bidirectional Algorithm (bidi)</ulink>. This is useful for supporting
    Arabic and Hebrew alphabets in other packages.</para>

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

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr &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>--disable-static</parameter>: prevent static libraries
    being built and installed.</para>

  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>fribidi and fribidi-config</seg>
        <seg>libfribidi.{so,a}</seg>
        <seg>/usr/include/fribidi</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="fribidi-prog">
        <term><command>fribidi</command></term>
        <listitem>
          <para>is a command-line interface to the
          <filename class='libraryfile'>libfribidi</filename> library and can
          be used to convert a logical string to visual output.</para>
          <indexterm zone="fribidi fribidi-prog">
            <primary sortas="b-fribidi">fribidi</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="fribidi-config">
        <term><command>fribidi-config</command></term>
        <listitem>
          <para>is used to acquire information about the installed
           <filename class='libraryfile'>libfribidi</filename> library.</para>
          <indexterm zone="fribidi fribidi-config">
            <primary sortas="b-fribidi-config">fribidi-config</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libfribidi">
        <term><filename class='libraryfile'>libfribidi.{so,a}</filename></term>
        <listitem>
          <para>contains functions used to implement the <ulink
          url="http://www.unicode.org/reports/tr9/"> Unicode Bidirectional
          Algorithm</ulink>.</para>
          <indexterm zone="fribidi libfribidi">
            <primary sortas="c-libfribidi">libfribidi.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>