source: general/graphlib/fribidi.xml@ 10e485f7

<?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 "https://github.com/fribidi/fribidi/releases/download/v&fribidi-version;/fribidi-&fribidi-version;.tar.xz">
  <!ENTITY fribidi-download-ftp  " ">
  <!ENTITY fribidi-md5sum        "49b17442e0d8fa2e97b5c898078f6f51">
  <!ENTITY fribidi-size          "1.1 MB">
  <!ENTITY fribidi-buildsize     "21 MB (with tests)">
  <!ENTITY fribidi-time          "less than 0.1 SBU (with tests)">
]>

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


  <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="https://www.unicode.org/reports/tr9/">Unicode
      Bidirectional Algorithm (BIDI)</ulink>. This is useful for supporting
      Arabic and Hebrew alphabets in other packages.
    </para>

    &lfs120_checked;

    <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>

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <ulink url="https://www.ciselant.de/c2man/c2man.html">c2man (to build man pages)</ulink>
    </para>

  </sect2>

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

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

<screen><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

meson setup --prefix=/usr --buildtype=release .. &amp;&amp;
ninja</userinput></screen>

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

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

<screen role="root"><userinput>ninja install</userinput></screen>
  </sect2>

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

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/meson-buildtype-release.xml"/>
  </sect2>

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

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

      <seglistitem>
        <seg>
          fribidi
        </seg>
        <seg>
          libfribidi.so
        </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="libfribidi">
        <term><filename class="libraryfile">libfribidi.so</filename></term>
        <listitem>
          <para>
            contains functions used to implement the
            <ulink url="https://www.unicode.org/reports/tr9/">Unicode
            Bidirectional Algorithm</ulink>
          </para>
          <indexterm zone="fribidi libfribidi">
            <primary sortas="c-libfribidi">libfribidi.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>