source: archive/id3lib.xml@ 45f56ac

<?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 id3lib-download-http "&sourceforge-repo;/id3lib/id3lib-&id3lib-version;.tar.gz">
  <!ENTITY id3lib-download-ftp  " ">
  <!ENTITY id3lib-md5sum        "19f27ddd2dda4b2d26a559a4f0f402a7">
  <!ENTITY id3lib-size          "950 KB">
  <!ENTITY id3lib-buildsize     "21 MB">
  <!ENTITY id3lib-time          "0.6 SBU">
]>

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

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

  <title>Id3lib-&id3lib-version;</title>

  <indexterm zone="id3lib">
    <primary sortas="a-Id3lib">Id3lib</primary>
  </indexterm>

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

    <para><application>id3lib</application> is a library for reading,
    writing and manipulating ID3v1 and ID3v2 tags.</para>

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

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Required patches: <ulink
        url="&patch-root;/id3lib-&id3lib-version;-gcc43-1.patch"/>, and <ulink
        url="&patch-root;/id3lib-&id3lib-version;-test_suite-1.patch"/></para>
      </listitem>
    </itemizedlist>

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

  </sect2>

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

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

<screen><userinput>patch -Np1 -i ../id3lib-&id3lib-version;-gcc43-1.patch &amp;&amp;
patch -Np1 -i ../id3lib-&id3lib-version;-test_suite-1.patch &amp;&amp;
./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 &amp;&amp;
install -v -m755 -d /usr/share/doc/id3lib-&id3lib-version; &amp;&amp;
install -v -m644 doc/*.{gif,jpg,png,ico,css,txt,php,html} \
    /usr/share/doc/id3lib-&id3lib-version;</userinput></screen>

  </sect2>

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

    <para><option>--enable-shared --disable-static</option>: This pair
    of switches prevents the static libraries in this package from being
    built and installed.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>id3convert, id3cp, id3info, and id3tag</seg>
        <seg>libid3.{so,a}</seg>
        <seg>/usr/include/id3 and /usr/share/doc/id3lib-3.8.3</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="id3convert">
        <term><command>id3convert</command></term>
        <listitem>
          <para>converts between ID3v1/v2 tagging formats.</para>
          <indexterm zone="id3lib id3convert">
            <primary sortas="b-id3convert">id3convert</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="id3cp">
        <term><command>id3cp</command></term>
        <listitem>
          <para>extracts ID3v1/v2 tags from digital audio files.</para>
          <indexterm zone="id3lib id3cp">
            <primary sortas="b-id3cp">id3cp</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="id3info">
        <term><command>id3info</command></term>
        <listitem>
          <para>prints ID3v1/v2 tag contents.</para>
          <indexterm zone="id3lib id3info">
            <primary sortas="b-id3info">id3info</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="id3tag">
        <term><command>id3tag</command></term>
        <listitem>
          <para>is an utility for editing ID3v1/v2 tags.</para>
          <indexterm zone="id3lib id3tag">
            <primary sortas="b-id3tag">id3tag</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libid3">
        <term><filename class='libraryfile'>libid3.{so,a}</filename></term>
        <listitem>
          <para>provides functions for the ID3v1/v2 tag editing
          programs as well as other external programs and libraries.</para>
          <indexterm zone="id3lib libid3">
            <primary sortas="c-libid3">libid3.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>