source: general/genutils/recode.xml@ 82b70873

<?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 recode-download-http "http://ftp.gnu.org/gnu/recode/recode-&recode-version;.tar.gz">
  <!ENTITY recode-download-ftp  "ftp://ftp.gnu.org/gnu/recode/recode-&recode-version;.tar.gz">
  <!ENTITY recode-md5sum        "be3f40ad2e93dae5cd5f628264bf1877">
  <!ENTITY recode-size          "1.7 MB">
  <!ENTITY recode-buildsize     "24 MB">
  <!ENTITY recode-time          "0.1 SBU">
]>

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

  <sect1info>
    <othername>$LastChangedBy: randy $</othername>
    <date>$Date: 2007-01-19 00:38:19 +0500 (Птн, 19 Янв 2007) $</date>
  </sect1info>

  <title>Recode-&recode-version;</title>

  <indexterm zone="recode">
    <primary sortas="a-Recode">Recode</primary>
  </indexterm>

  <!--Required section-->
  <sect2 role="package">
    <title>Introduction to Recode</title>

    <para>The <application>Recode</application> package contains a program for
    converting text between character sets, and a library that exposes
    this functionality to other applications. Note that the same functionality
    (but with different API) is provided by <command>iconv</command>, which is
    installed in LFS as a part of <application>Glibc</application>.</para>
    
    <note>
      <para>The <application>Recode</application> package is no longer
      maintained upstream. Wishlist bugs such as
      <ulink url="http://bugs.debian.org/94966"/> will never be fixed.</para>
    </note>

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

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Required patch: <ulink
        url="&patch-root;/recode-&recode-version;-fixes-1.patch"/></para>
      </listitem>
    </itemizedlist>

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="python"/>
    (for the <quote>bigauto</quote> test) and
    <ulink url="http://dmalloc.com/">Dmalloc</ulink></para>

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

  </sect2>

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

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

<screen><userinput>patch -Np1 -i ../recode-&recode-version;-fixes-1.patch &amp;&amp;
./configure --prefix=/usr --without-included-gettext &amp;&amp;
make</userinput></screen>

    <para>To test the results, issue: <command>make check</command>. The
    testsuite will warn about the <quote>bigauto</quote> test being
    skipped. The editors did not attempt to run this test to the end, because
    it uses obsolete Python constructions.</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>--without-included-gettext</parameter>: This parameter
    forces the use of <function>gettext</function> implementation provided
    by <application>Glibc</application> instead of the very old internal copy.
    The internal copy produces incorrect output in UTF-8 locales.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>recode</seg>
        <seg>librecode.{so,a}</seg>
        <seg>None</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="recode-prog">
        <term><command>recode</command></term>
        <listitem>
          <para>converts text between character sets.</para>
          <indexterm zone="recode recode-prog">
            <primary sortas="b-recode">recode</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="librecode">
        <term><filename class='libraryfile'>librecode.{so,a}</filename></term>
        <listitem>
          <para>contains functions for character set conversion.</para>
          <indexterm zone="recode librecode">
            <primary sortas="c-librecode">librecode.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>