source: multimedia/libdriv/audiofile.xml@ f3ebc751

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY audiofile-download-http "http://www.68k.org/~michael/audiofile/audiofile-&audiofile-version;.tar.gz">
  <!ENTITY audiofile-download-ftp  " ">
  <!ENTITY audiofile-md5sum        "9c1049876cd51c0f1b12c2886cce4d42">
  <!ENTITY audiofile-size          "374 KB">
  <!ENTITY audiofile-buildsize     "8.5 MB">
  <!ENTITY audiofile-time          "0.23 SBU">
]>

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

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

  <title>Audio File-&audiofile-version;</title>

  <indexterm zone="audiofile">
    <primary sortas="a-Audio-File">Audio File</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Audio File</title>

    <para>The <application>Audio File</application> package contains the
    audio file libraries and two sound file support programs. These are useful
    to support basic sound file formats.</para>

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

  </sect2>

  <sect2 role="installation">
    <title>Installation of Audio File</title>

    <para>Install <application>Audio File</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="content">
    <title>Contents</title>

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

      <seglistitem>
        <seg>audiofile-config, sfinfo, and sfconvert</seg>
        <seg>libaudiofile.[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="audiofile-config">
        <term><command>audiofile-config</command></term>
        <listitem>
          <para>is used during the compile process by programs linking to this
          library.</para>
          <indexterm zone="audiofile audiofile-config">
            <primary sortas="b-audiofile-config">audiofile-config</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="sfinfo">
        <term><command>sfinfo</command></term>
        <listitem>
          <para>displays the sound file format, audio encoding, sampling
          rate and duration for audio formats supported by this library.</para>
          <indexterm zone="audiofile sfinfo">
            <primary sortas="b-sfinfo">sfinfo</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="sfconvert">
        <term><command>sfconvert</command></term>
        <listitem>
          <para>converts sound file formats where the original format and
          destination format are supported by this library.</para>
          <indexterm zone="audiofile sfconvert">
            <primary sortas="b-sfconvert">sfconvert</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libaudiofile">
        <term><filename class='libraryfile'>libaudiofile.[so,a]</filename></term>
        <listitem>
          <para>contains functions used by programs to support AIFF,
          AIFF-compressed, Sun/NeXT, WAV and BIC audio formats.</para>
          <indexterm zone="audiofile libaudiofile">
            <primary sortas="c-libaudiofile">libaudiofile.[so,a]</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>