source: multimedia/libdriv/nas.xml@ 0aeb696

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

    <!-- Inserted as a reminder to do this. The mention of a test suite
         is usually right before the root user installation commands. Please
         delete these 12 (including one blank) lines after you are done.-->

    <!-- Use one of the two mentions below about a test suite,
         delete the line that is not applicable. Of course, if the
         test suite uses syntax other than "make check", revise the
         line to reflect the actual syntax to run the test suite -->

    <!-- <para>This package does not come with a test suite.</para> -->
    <!-- <para>To test the results, issue: <command>make check</command>.</para> -->

  <!ENTITY nas-download-http "http://nas.codebrilliance.com/nas/nas-&nas-version;.src.tar.gz">
  <!ENTITY nas-download-ftp  "ftp://ftp.us.xemacs.org/pub/xemacs/aux/nas-&nas-version;.src.tar.gz">
  <!ENTITY nas-md5sum        "c9918e9c9c95d587a95b455bbabe3b49">
  <!ENTITY nas-size          "1.2 MB">
  <!ENTITY nas-buildsize     "17.8 MB">
  <!ENTITY nas-time          "0.31 SBU">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
    <keywordset>
      <keyword role="package">nas-&nas-version;.src.tar</keyword>
      <keyword role="ftpdir">nas</keyword>
    </keywordset>
  </sect1info>

  <title>NAS-&nas-version;</title>

  <indexterm zone="nas">
    <primary sortas="a-NAS">NAS</primary>
  </indexterm>

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

    <para>The Network Audio System is a network transparent, client/server audio
    transport system used to read , write and play audio files in many formats
    including <filename>.au</filename>, <filename>.snd</filename>,
    <filename>.voc</filename>, <filename>.wav</filename>,
    <filename>.aiff</filename>, <filename>.aif</filename> and
    <filename>.iff</filename>. It can be described as the audio equivalent of an
    <application>X</application> server.</para>

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

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="x-window-system"/></para>

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

  </sect2>

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

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

<screen><userinput>patch -Np1 -i ../nas-&nas-version;-gcc4-1.patch &amp;&amp;
xmkmf &amp;&amp;
make World</userinput></screen>

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

<screen role="root"><userinput>make install install.man &amp;&amp;
install -v -m755 -d /usr/share/doc/nas-&nas-version;/pdf &amp;&amp;
install -v -m644 doc/pdf/* /usr/share/doc/nas-&nas-version;/pdf &amp;&amp;
install -v -m644 doc/{README,actions,*.{ps,txt}} \
    /usr/share/doc/nas-&nas-version;</userinput></screen>

  </sect2>

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

    <para><command>xmkmf</command>; <command>make World</command>:
    These commands use the standard for compiling <application>X</application>
    based applications.</para>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring NAS</title>

    <sect3 id="nas-config">
      <title>Config Files</title>

      <para><filename>/etc/nas/nasd.conf</filename></para>

      <indexterm zone="nas nas-config">
        <primary sortas="e-etc-nas-nasd.conf">/etc/nas/nasd.conf</primary>
      </indexterm>

    </sect3>

    <sect3>
      <title>Configuration Information</title>

      <para>Create the <application>NAS</application> configuration file using the
      following command:</para>

<screen role="root"><userinput>install -v -m644 /etc/nas/nasd.conf.eg /etc/nas/nasd.conf</userinput></screen>

      <para>Edit the new configuration file to suit your network and system
      needs.</para>

    </sect3>

    <sect3 id="nas-init">
      <title>Boot Script</title>

      <para>Install the <filename>/etc/rc.d/init.d/nas</filename> init script
      included in the <xref linkend="bootscripts"/>
      package.</para>

      <indexterm zone="nas nas-init">
        <primary sortas="f-nas">nas</primary>
      </indexterm>

<screen role="root"><userinput>make install-nas</userinput></screen>

      <para>The init script uses a default parameter to allow access to all hosts on
      the network. Review the <command>nasd</command> man page for other available
      parameters if you need to modify the script.</para>

    </sect3>

  </sect2>

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

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

      <seglistitem>
        <seg>auconvert, auctl, audemo, audial, auedit, auinfo, aupanel, auphone,
        auplay, aurecord, auscope, autool, auwave, checkmail, issndfile, nasd,
        playbucket, and soundtoh</seg>
        <seg>libaudio.{so,a}</seg>
        <seg>/etc/nas and /usr/X11R6/include/audio</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="au-utilities">
        <term><command>au{utilities}</command></term>
        <listitem>
          <para>are a collection of tools to convert, play, edit, record,
          and manipulate sound files. See the respective man page for each utility
          for a full description of each one.</para>
          <indexterm zone="nas au-utilities">
            <primary sortas="b-au-utilities">au{utilities}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="checkmail">
        <term><command>checkmail</command></term>
        <listitem>
          <para>plays a sound file when the user receives mail.</para>
          <indexterm zone="nas checkmail">
            <primary sortas="b-checkmail">checkmail</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="issndfile">
        <term><command>issndfile</command></term>
        <listitem>
          <para>checks if a file is in a recognized audio file format.</para>
          <indexterm zone="nas issndfile">
            <primary sortas="b-issndfile">issndfile</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="nasd">
        <term><command>nasd</command></term>
        <listitem>
          <para>is the Network Audio System server daemon.</para>
          <indexterm zone="nas nasd">
            <primary sortas="b-nasd">nasd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="playbucket">
        <term><command>playbucket</command></term>
        <listitem>
          <para>plays, or creates, the bucket corresponding to the
          specified file.</para>
          <indexterm zone="nas playbucket">
            <primary sortas="b-playbucket">playbucket</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="soundtoh">
        <term><command>soundtoh</command></term>
        <listitem>
          <para>converts a sound file to a C language header file.</para>
          <indexterm zone="nas soundtoh">
            <primary sortas="b-soundtoh">soundtoh</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libaudio">
        <term><filename class='libraryfile'>libaudio.{so,a}</filename></term>
        <listitem>
          <para>contains API functions to read and write audio files.</para>
          <indexterm zone="nas libaudio">
            <primary sortas="c-libaudio">libaudio.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>