[52d29f7] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[ff769b8c] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
|
---|
[52d29f7] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[06a0740d] | 7 | <!ENTITY fam-download-http "http://gd.tuwien.ac.at/opsys/linux/gentoo/distfiles/fam-&fam-version;.tar.gz">
|
---|
| 8 | <!ENTITY fam-download-ftp "ftp://oss.sgi.com/projects/fam/download/stable/fam-&fam-version;.tar.gz">
|
---|
| 9 | <!ENTITY fam-md5sum "1bf3ae6c0c58d3201afc97c6a4834e39">
|
---|
| 10 | <!ENTITY fam-size "301 KB">
|
---|
| 11 | <!ENTITY fam-buildsize "7.7 MB">
|
---|
| 12 | <!ENTITY fam-time "0.26 SBU">
|
---|
[52d29f7] | 13 | ]>
|
---|
| 14 |
|
---|
[6492ac2] | 15 | <sect1 id="fam" xreflabel="FAM-&fam-version;">
|
---|
[06a0740d] | 16 | <?dbhtml filename="fam.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>FAM-&fam-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="fam">
|
---|
| 26 | <primary sortas="a-FAM">FAM</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to FAM</title>
|
---|
| 31 |
|
---|
| 32 | <para>The <application>FAM</application> package contains a
|
---|
| 33 | File Alteration Monitor which is useful for notifying applications of
|
---|
| 34 | changes to the file system.</para>
|
---|
| 35 |
|
---|
| 36 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 37 | <itemizedlist spacing="compact">
|
---|
| 38 | <listitem>
|
---|
| 39 | <para>Download (HTTP): <ulink url="&fam-download-http;"/></para>
|
---|
| 40 | </listitem>
|
---|
| 41 | <listitem>
|
---|
| 42 | <para>Download (FTP): <ulink url="&fam-download-ftp;"/></para>
|
---|
| 43 | </listitem>
|
---|
| 44 | <listitem>
|
---|
| 45 | <para>Download MD5 sum: &fam-md5sum;</para>
|
---|
| 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
| 48 | <para>Download size: &fam-size;</para>
|
---|
| 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
| 51 | <para>Estimated disk space required: &fam-buildsize;</para>
|
---|
| 52 | </listitem>
|
---|
| 53 | <listitem>
|
---|
| 54 | <para>Estimated build time: &fam-time;</para>
|
---|
| 55 | </listitem>
|
---|
| 56 | </itemizedlist>
|
---|
| 57 |
|
---|
| 58 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
| 59 | <itemizedlist spacing='compact'>
|
---|
| 60 | <listitem>
|
---|
| 61 | <para>Dnotify patch (Recommended):
|
---|
| 62 | <ulink url="&patch-root;/fam-&fam-version;-dnotify-1.patch"/></para>
|
---|
| 63 | </listitem>
|
---|
| 64 | </itemizedlist>
|
---|
| 65 |
|
---|
| 66 | <bridgehead renderas="sect3">FAM Dependencies</bridgehead>
|
---|
| 67 |
|
---|
| 68 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 69 | <para><xref linkend="portmap"/></para>
|
---|
| 70 |
|
---|
| 71 | </sect2>
|
---|
| 72 |
|
---|
| 73 | <sect2 role="installation">
|
---|
| 74 | <title>Installation of FAM</title>
|
---|
| 75 |
|
---|
| 76 | <para>Install <application>FAM</application> by running the
|
---|
| 77 | following commands:</para>
|
---|
| 78 |
|
---|
| 79 | <screen><userinput>patch -Np1 -i ../fam-&fam-version;-dnotify-1.patch &&
|
---|
[e3353b3] | 80 | chmod -v 755 configure &&
|
---|
[52d29f7] | 81 | autoreconf -f -i &&
|
---|
| 82 | ./configure --prefix=/usr --sysconfdir=/etc &&
|
---|
[06a0740d] | 83 | make</userinput></screen>
|
---|
| 84 |
|
---|
| 85 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 86 |
|
---|
| 87 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 88 |
|
---|
| 89 | </sect2>
|
---|
| 90 |
|
---|
| 91 | <sect2 role="commands">
|
---|
| 92 | <title>Command Explanations</title>
|
---|
| 93 |
|
---|
| 94 | <para><command>patch -Np1 -i ../fam-&fam-version;-dnotify-1.patch</command>:
|
---|
| 95 | This patch enables <application>FAM</application> to use
|
---|
| 96 | the Linux kernel dnotify mechanism to inform the calling process of
|
---|
| 97 | file modifications, rather than polling the file system for
|
---|
| 98 | modifications.</para>
|
---|
| 99 |
|
---|
[e3353b3] | 100 | <para><command>chmod -v 755 configure</command>: <command>configure</command> is
|
---|
[06a0740d] | 101 | set to read-only and <command>autoreconf</command> will fail if the
|
---|
| 102 | permissions aren't changed.</para>
|
---|
| 103 |
|
---|
| 104 | <para><command>autoreconf -f -i</command>: The autotools need rebuilding
|
---|
| 105 | because the dnotify patch affects <filename>configure.ac</filename> and
|
---|
| 106 | <filename>Makefile.am</filename>.</para>
|
---|
| 107 |
|
---|
| 108 | </sect2>
|
---|
| 109 |
|
---|
| 110 | <sect2 role="configuration">
|
---|
| 111 | <title>Configuring FAM</title>
|
---|
| 112 |
|
---|
| 113 | <sect3 id='fam-config'>
|
---|
| 114 | <title>Config Files</title>
|
---|
| 115 |
|
---|
| 116 | <para><filename>/etc/rpc</filename>,
|
---|
| 117 | <filename>/etc/fam.conf</filename>,
|
---|
| 118 | <filename>/etc/inetd.conf</filename> or
|
---|
| 119 | <filename>/etc/xinetd.conf</filename> or
|
---|
| 120 | <filename>/etc/xinetd.d/fam</filename></para>
|
---|
| 121 |
|
---|
| 122 | <indexterm zone="fam fam-config">
|
---|
| 123 | <primary sortas="e-etc-rpc">/etc/rpc</primary>
|
---|
| 124 | </indexterm>
|
---|
| 125 |
|
---|
| 126 | <indexterm zone="fam fam-config">
|
---|
| 127 | <primary sortas="e-etc-fam.conf">/etc/fam.conf</primary>
|
---|
| 128 | </indexterm>
|
---|
| 129 |
|
---|
| 130 | <indexterm zone="fam fam-config">
|
---|
| 131 | <primary sortas="e-etc-inetd.conf">/etc/inetd.conf</primary>
|
---|
| 132 | </indexterm>
|
---|
| 133 |
|
---|
| 134 | <indexterm zone="fam fam-config">
|
---|
| 135 | <primary sortas="e-etc-xinetd.conf">/etc/xinetd.conf</primary>
|
---|
| 136 | </indexterm>
|
---|
| 137 |
|
---|
| 138 | <indexterm zone="fam fam-config">
|
---|
| 139 | <primary sortas="e-etc-xinetd.d-sgi_fam">/etc/xinetd.d/sgi_fam</primary>
|
---|
| 140 | </indexterm>
|
---|
| 141 |
|
---|
| 142 | </sect3>
|
---|
| 143 |
|
---|
| 144 | <sect3>
|
---|
| 145 | <title>Configuration Information</title>
|
---|
| 146 |
|
---|
| 147 | <para>Configuring the File Alteration Monitor.</para>
|
---|
| 148 |
|
---|
| 149 | <para>If you use <application>inetd</application>, add the
|
---|
| 150 | <application>FAM</application> entry to
|
---|
| 151 | <filename>/etc/inetd.conf</filename> with the following command:</para>
|
---|
| 152 |
|
---|
| 153 | <screen role="root"><userinput>echo "sgi_fam/1-2 stream rpc/tcp wait root /usr/sbin/famd fam" \
|
---|
| 154 | >> /etc/inetd.conf</userinput></screen>
|
---|
| 155 |
|
---|
| 156 | <para>If you use <application>xinetd</application>, the following command will
|
---|
| 157 | create the <application>FAM</application> file as
|
---|
[0f0ee329] | 158 | <filename>/etc/xinetd.d/sgi_fam</filename> (be sure the
|
---|
| 159 | <systemitem class="groupname">nogroup</systemitem> group exists):</para>
|
---|
[06a0740d] | 160 |
|
---|
| 161 | <screen role="root"><userinput>cat >> /etc/xinetd.d/sgi_fam << "EOF"
|
---|
| 162 | <literal># Begin /etc/xinetd.d/sgi_fam
|
---|
[1f672c1] | 163 |
|
---|
| 164 | # description: FAM - file alteration monitor
|
---|
[52d29f7] | 165 | service sgi_fam
|
---|
| 166 | {
|
---|
| 167 | type = RPC UNLISTED
|
---|
| 168 | socket_type = stream
|
---|
| 169 | user = root
|
---|
| 170 | group = nogroup
|
---|
| 171 | server = /usr/sbin/famd
|
---|
| 172 | wait = yes
|
---|
| 173 | protocol = tcp
|
---|
| 174 | rpc_version = 2
|
---|
| 175 | rpc_number = 391002
|
---|
| 176 | }
|
---|
[1f672c1] | 177 |
|
---|
[06a0740d] | 178 | # End /etc/xinetd.d/sgi_fam</literal>
|
---|
| 179 | EOF</userinput></screen>
|
---|
| 180 |
|
---|
| 181 | <para id='fam-init'>If you do not have an <command>inetd</command> daemon
|
---|
| 182 | installed and have no wish to install one, you can also start
|
---|
| 183 | <command>famd</command> during system startup by installing the
|
---|
| 184 | <filename>/etc/rc.d/init.d/fam</filename> init script included in the
|
---|
| 185 | <xref linkend="intro-important-bootscripts"/> package.</para>
|
---|
| 186 |
|
---|
| 187 | <screen role="root"><userinput>make install-fam</userinput></screen>
|
---|
| 188 |
|
---|
| 189 | <indexterm zone="fam fam-init">
|
---|
| 190 | <primary sortas="f-fam">fam</primary>
|
---|
| 191 | </indexterm>
|
---|
| 192 |
|
---|
| 193 | </sect3>
|
---|
| 194 |
|
---|
| 195 | </sect2>
|
---|
| 196 |
|
---|
| 197 | <sect2 role="content">
|
---|
| 198 | <title>Contents</title>
|
---|
| 199 |
|
---|
| 200 | <segmentedlist>
|
---|
| 201 | <segtitle>Installed Program</segtitle>
|
---|
| 202 | <segtitle>Installed Library</segtitle>
|
---|
| 203 | <segtitle>Installed Directories</segtitle>
|
---|
| 204 |
|
---|
| 205 | <seglistitem>
|
---|
| 206 | <seg>famd</seg>
|
---|
| 207 | <seg>libfam.[so,a]</seg>
|
---|
| 208 | <seg>None</seg>
|
---|
| 209 | </seglistitem>
|
---|
| 210 | </segmentedlist>
|
---|
| 211 |
|
---|
| 212 | <variablelist>
|
---|
| 213 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 214 | <?dbfo list-presentation="list"?>
|
---|
| 215 | <?dbhtml list-presentation="table"?>
|
---|
| 216 |
|
---|
| 217 | <varlistentry id="famd">
|
---|
| 218 | <term><command>famd</command></term>
|
---|
| 219 | <listitem>
|
---|
| 220 | <para>is the file alteration monitor daemon.</para>
|
---|
| 221 | <indexterm zone="fam famd">
|
---|
| 222 | <primary sortas="b-famd">famd</primary>
|
---|
| 223 | </indexterm>
|
---|
| 224 | </listitem>
|
---|
| 225 | </varlistentry>
|
---|
| 226 |
|
---|
| 227 | <varlistentry id="libfam">
|
---|
| 228 | <term><filename class='libraryfile'>libfam.[so,a]</filename></term>
|
---|
| 229 | <listitem>
|
---|
| 230 | <para>contains functions that support the file allocation monitor.</para>
|
---|
| 231 | <indexterm zone="fam libfam">
|
---|
| 232 | <primary sortas="c-libfam">libfam.[so,a]</primary>
|
---|
| 233 | </indexterm>
|
---|
| 234 | </listitem>
|
---|
| 235 | </varlistentry>
|
---|
| 236 |
|
---|
| 237 | </variablelist>
|
---|
| 238 |
|
---|
| 239 | </sect2>
|
---|
[6492ac2] | 240 |
|
---|
| 241 | </sect1>
|
---|
[52d29f7] | 242 |
|
---|