source: general/genlib/fam.xml@ d227be52

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

<!ENTITY fam-download-http "http://gd.tuwien.ac.at/opsys/linux/gentoo/distfiles/fam-&fam-version;.tar.gz">
<!ENTITY fam-download-ftp "ftp://oss.sgi.com/projects/fam/download/stable/fam-&fam-version;.tar.gz">
<!ENTITY fam-md5sum "1bf3ae6c0c58d3201afc97c6a4834e39">
<!ENTITY fam-size "320 KB">
<!ENTITY fam-buildsize "6.9 MB">
<!ENTITY fam-time "0.37 SBU">
]>

<sect1 id="fam" xreflabel="FAM-&fam-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="fam.html"?>
<title>FAM-&fam-version;</title>

<sect2>
<title>Introduction to <application><acronym>FAM</acronym></application></title>

<para>The <application><acronym>FAM</acronym></application> package contains a
File Alteration Monitor which is useful for notifying applications of
changes to the file system.</para>

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

<sect3><title>Additional downloads</title>
<itemizedlist spacing='compact'>
<listitem><para>Dnotify patch (Recommended): <ulink
url="&patch-root;/fam-&fam-version;-dnotify-1.patch"/></para></listitem>
</itemizedlist>
</sect3>

<sect3><title><application><acronym>FAM</acronym></application> dependencies
</title>
<sect4><title>Required</title>
<para><xref linkend="portmap"/></para></sect4>
</sect3>

</sect2>

<sect2>
<title>Installation of <application><acronym>FAM</acronym></application></title>

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

<screen><userinput><command>patch -Np1 -i ../fam-&fam-version;-dnotify-1.patch &amp;&amp;
chmod 755 configure &amp;&amp;
autoreconf -f -i &amp;&amp;
./configure --prefix=/usr --sysconfdir=/etc &amp;&amp;
make &amp;&amp;
make install</command></userinput></screen>

</sect2>

<sect2>
<title>Command explanations</title>

<para><command>patch -Np1 -i ../fam-&fam-version;-dnotify-1.patch</command>: 
This patch enables <application><acronym>FAM</acronym></application> to use 
the Linux kernel dnotify mechanism to inform the calling process of
file modifications, rather than polling the file system for
modifications.</para>

<para><command>chmod 755 configure</command>: <command>configure</command> is 
set to read-only and <command>autoreconf</command> will fail if the 
permissions aren't changed.</para>

<para><command>autoreconf -f -i</command>: The autotools need rebuilding 
because the dnotify patch affects <filename>configure.ac</filename> and 
<filename>Makefile.am</filename>.</para>

</sect2>

<sect2>
<title>Configuring <application><acronym>FAM</acronym></application></title>

<sect3><title>Config files</title>

<para><filename>/etc/rpc</filename>,
 <filename>/etc/fam.conf</filename>,
 <filename>/etc/inetd.conf</filename>,
 <filename>/etc/xinetd.d/fam</filename>
 or <filename>/etc/xinetd.conf</filename>
 </para>
</sect3>

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

<para>Configuring the file alteration monitor.</para>

<para>If you use <application>inetd</application>, add the
<application><acronym>FAM</acronym></application> entry to
<filename>/etc/inetd.conf</filename> with the
following command:</para>

<screen><userinput><command>echo "sgi_fam/1-2 stream  rpc/tcp wait root /usr/sbin/famd fam" \
    &gt;&gt; /etc/inetd.conf</command></userinput></screen>

<para>If you use <application>xinetd</application>, add an entry to
<filename>/etc/xinetd.conf</filename> with the following command (be
sure the "nogroup" group exists):</para>

<screen><userinput><command>cat &gt;&gt; /etc/xinetd.conf &lt;&lt; "EOF"</command>
    # description: FAM - file alteration monitor
    service sgi_fam
    {
        type            = RPC UNLISTED
        socket_type     = stream
        user            = root
        group           = nogroup
        server          = /usr/sbin/famd
        wait            = yes
        protocol        = tcp
        rpc_version     = 2
        rpc_number      = 391002
    }
<command>EOF</command></userinput></screen>

<para>If you do not have an <command>inetd</command> daemon installed and have 
no wish to install one, you can also start <command>famd</command> during 
system startup by installing the <filename>/etc/rc.d/init.d/fam</filename>
init script included in the
<xref linkend="intro-important-bootscripts"/> package.</para>

<screen><userinput><command>make install-fam</command></userinput></screen>

</sect3>

</sect2>

<sect2>
<title>Contents</title>

<para>The <application><acronym>FAM</acronym></application> package contains
the <command>famd</command> executable and <filename>libfam</filename>
libraries.</para>

</sect2>

<sect2><title>Description</title>

<sect3><title>famd</title>

<para><command>famd</command> is the file alteration monitor.</para>

</sect3>

</sect2>

</sect1>