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