glfs/general/genlib/uchardet.xml

<?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 uchardet-download-http "https://www.freedesktop.org/software/uchardet/releases/uchardet-&uchardet-version;.tar.xz">
  <!ENTITY uchardet-download-ftp  " ">
  <!ENTITY uchardet-md5sum        "9e267be7aee81417e5875086dd9d44fd">
  <!ENTITY uchardet-size          "217 KB">
  <!ENTITY uchardet-buildsize     "4.6 MB (with test)">
  <!ENTITY uchardet-time          "less than 0.1 SBU (with test)">

]>

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


  <title>Uchardet-&uchardet-version;</title>

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

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

    <para>
      The <application>Uchardet</application> package contains an encoding
      detectory library which takes a sequence of bytes in an unknown character
      encoding and attempts to determine the encoding of the text.
    </para>

    &lfs120_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="cmake"/>
    </para>

  </sect2>

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

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

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

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DBUILD_STATIC=OFF          \
      -Wno-dev ..                 &amp;&amp;
make</userinput></screen>

    <para>
      To test the results, issue: <command>make test</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>-DBUILD_STATIC=OFF</parameter>: This switch disables building
      the static version of the library.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          uchardet
        </seg>
        <seg>
          libuchardet.so
        </seg>
        <seg>
          /usr/include/uchardet
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="uchardet-prog">
        <term><command>uchardet</command></term>
        <listitem>
          <para>
            detects what character set is used inside of a file
          </para>
          <indexterm zone="uchardet uchardet-prog">
            <primary sortas="b-uchardet">uchardet</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libuchardet">
        <term><filename class="libraryfile">libuchardet.so</filename></term>
        <listitem>
          <para>
            provides an API for detecting the encoding of text in a file
          </para>
          <indexterm zone="uchardet libuchardet">
            <primary sortas="c-libuchardet">libuchardet.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>

</sect1>