[b7ea972] | 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" [
|
---|
[b7ea972] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!ENTITY gamin-download-http "http://www.gnome.org/~veillard/gamin/sources/gamin-&gamin-version;.tar.gz">
|
---|
[fb2e525] | 8 | <!ENTITY gamin-download-ftp "&gentoo-ftp-repo;/gamin-&gamin-version;.tar.gz">
|
---|
[52f6fa3] | 9 | <!ENTITY gamin-md5sum "2d3a6a70df090ed923238e381e6c2982">
|
---|
| 10 | <!ENTITY gamin-size "632 KB">
|
---|
[e249f83] | 11 | <!ENTITY gamin-buildsize "6 MB">
|
---|
[fd2aad88] | 12 | <!ENTITY gamin-time "0.1 SBU (up to 3 minutes, processor independent, to run the test suite)">
|
---|
[b7ea972] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="gamin" xreflabel="Gamin-&gamin-version;">
|
---|
| 16 | <?dbhtml filename="gamin.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
[8cc8d59] | 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
[b7ea972] | 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>Gamin-&gamin-version;</title>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
| 26 | <title>Introduction to Gamin</title>
|
---|
| 27 |
|
---|
| 28 | <para>The <application>Gamin</application> package contains a
|
---|
| 29 | File Alteration Monitor which is useful for notifying applications of
|
---|
| 30 | changes to the file system. Gamin is compatible with <ulink
|
---|
[4f26c54] | 31 | url="http://oss.sgi.com/projects/fam/">FAM</ulink>.</para>
|
---|
[b7ea972] | 32 |
|
---|
| 33 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 34 | <itemizedlist spacing="compact">
|
---|
| 35 | <listitem>
|
---|
| 36 | <para>Download (HTTP): <ulink url="&gamin-download-http;"/></para>
|
---|
| 37 | </listitem>
|
---|
| 38 | <listitem>
|
---|
| 39 | <para>Download (FTP): <ulink url="&gamin-download-ftp;"/></para>
|
---|
| 40 | </listitem>
|
---|
| 41 | <listitem>
|
---|
| 42 | <para>Download MD5 sum: &gamin-md5sum;</para>
|
---|
| 43 | </listitem>
|
---|
| 44 | <listitem>
|
---|
| 45 | <para>Download size: &gamin-size;</para>
|
---|
| 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
| 48 | <para>Estimated disk space required: &gamin-buildsize;</para>
|
---|
| 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
| 51 | <para>Estimated build time: &gamin-time;</para>
|
---|
| 52 | </listitem>
|
---|
| 53 | </itemizedlist>
|
---|
| 54 |
|
---|
| 55 | <bridgehead renderas="sect3">Gamin Dependencies</bridgehead>
|
---|
| 56 |
|
---|
| 57 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[4f26c54] | 58 | <para role="required"><xref linkend="glib2"/></para>
|
---|
[b7ea972] | 59 |
|
---|
| 60 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[fd2aad88] | 61 | <para role="optional"><xref linkend="python"/></para>
|
---|
| 62 |
|
---|
| 63 | <!-- Though configure mentions these two packages, the build
|
---|
| 64 | system can and does absolutely nothing with them. Commenting
|
---|
| 65 | them out for now, as they cannot be used
|
---|
| 66 | <xref linkend="gtk-doc"/> (for building API documentation),
|
---|
[4f26c54] | 67 | <xref linkend="doxygen"/> (for building documentation),
|
---|
[fd2aad88] | 68 | -->
|
---|
[b7ea972] | 69 |
|
---|
[1039de3] | 70 | <para condition="html" role="usernotes">User Notes:
|
---|
| 71 | <ulink url="&blfs-wiki;/gamin"/></para>
|
---|
| 72 |
|
---|
[b7ea972] | 73 | </sect2>
|
---|
| 74 |
|
---|
| 75 | <sect2 role="installation">
|
---|
| 76 | <title>Installation of Gamin</title>
|
---|
| 77 |
|
---|
| 78 | <para>Install <application>Gamin</application> by running the
|
---|
| 79 | following commands:</para>
|
---|
| 80 |
|
---|
| 81 | <screen><userinput>./configure --prefix=/usr --libexecdir=/usr/sbin &&
|
---|
| 82 | make</userinput></screen>
|
---|
| 83 |
|
---|
[e249f83] | 84 | <para>To test the results, issue: <command>make check</command>. Note
|
---|
| 85 | that some tests may display errors.</para>
|
---|
[b7ea972] | 86 |
|
---|
| 87 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 88 |
|
---|
[fd2aad88] | 89 | <screen role="root"><userinput>make install &&
|
---|
[6473e74] | 90 | install -v -m755 -d /usr/share/doc/gamin-&gamin-version; &&
|
---|
[fd2aad88] | 91 | install -v -m644 doc/*.{html,fig,gif,txt} /usr/share/doc/gamin-&gamin-version;</userinput></screen>
|
---|
[b7ea972] | 92 |
|
---|
| 93 | </sect2>
|
---|
| 94 |
|
---|
| 95 | <sect2 role="configuration">
|
---|
| 96 | <title>Configuring Gamin</title>
|
---|
| 97 |
|
---|
| 98 | <sect3>
|
---|
| 99 | <title>Configuration Information</title>
|
---|
| 100 |
|
---|
| 101 | <para>No configuration is generally required and the default options
|
---|
| 102 | should work for most users. See
|
---|
| 103 | <ulink url="http://www.gnome.org/~veillard/gamin/config.html"/> for
|
---|
| 104 | details.</para>
|
---|
| 105 |
|
---|
| 106 | </sect3>
|
---|
| 107 |
|
---|
| 108 | </sect2>
|
---|
| 109 |
|
---|
| 110 | <sect2 role="content">
|
---|
| 111 | <title>Contents</title>
|
---|
| 112 |
|
---|
| 113 | <segmentedlist>
|
---|
| 114 | <segtitle>Installed Program</segtitle>
|
---|
[fd2aad88] | 115 | <segtitle>Installed Libraries</segtitle>
|
---|
| 116 | <segtitle>Installed Directory</segtitle>
|
---|
[b7ea972] | 117 |
|
---|
| 118 | <seglistitem>
|
---|
| 119 | <seg>gam_server</seg>
|
---|
[1039de3] | 120 | <seg>libfam.{so,a}, libgamin-1.{so,a}, libgamin_shared.a and
|
---|
| 121 | optionally, <application>Python</application> _gamin.{so,a}
|
---|
[fd2aad88] | 122 | module</seg>
|
---|
| 123 | <seg>/usr/share/doc/gamin-&gamin-version;</seg>
|
---|
[b7ea972] | 124 | </seglistitem>
|
---|
| 125 | </segmentedlist>
|
---|
| 126 |
|
---|
| 127 | <variablelist>
|
---|
| 128 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 129 | <?dbfo list-presentation="list"?>
|
---|
| 130 | <?dbhtml list-presentation="table"?>
|
---|
| 131 |
|
---|
[060409a] | 132 | <varlistentry id="gam_server">
|
---|
[b7ea972] | 133 | <term><command>gam_server</command></term>
|
---|
| 134 | <listitem>
|
---|
| 135 | <para>is the file alteration monitor daemon that is started on demand
|
---|
| 136 | for each user.</para>
|
---|
[060409a] | 137 | <indexterm zone="gamin gam_server">
|
---|
| 138 | <primary sortas="b-gam_server">gam_server</primary>
|
---|
[b7ea972] | 139 | </indexterm>
|
---|
| 140 | </listitem>
|
---|
| 141 | </varlistentry>
|
---|
| 142 |
|
---|
| 143 | <varlistentry id="libgamin">
|
---|
[1039de3] | 144 | <term><filename class='libraryfile'>libgamin.{so,a}</filename></term>
|
---|
[b7ea972] | 145 | <listitem>
|
---|
| 146 | <para>contains functions that support the file allocation monitor.</para>
|
---|
| 147 | <indexterm zone="gamin libgamin">
|
---|
[1039de3] | 148 | <primary sortas="c-libgamin">libgamin.{so,a}</primary>
|
---|
[b7ea972] | 149 | </indexterm>
|
---|
| 150 | </listitem>
|
---|
| 151 | </varlistentry>
|
---|
| 152 |
|
---|
| 153 | <varlistentry id="libfam">
|
---|
[1039de3] | 154 | <term><filename class='libraryfile'>libfam.{so,a}</filename></term>
|
---|
[b7ea972] | 155 | <listitem>
|
---|
| 156 | <para>contains functions that provide compatibility with FAM.</para>
|
---|
| 157 | <indexterm zone="gamin libfam">
|
---|
[1039de3] | 158 | <primary sortas="c-libfam">libfam.{so,a}</primary>
|
---|
[b7ea972] | 159 | </indexterm>
|
---|
| 160 | </listitem>
|
---|
| 161 | </varlistentry>
|
---|
| 162 |
|
---|
| 163 | </variablelist>
|
---|
| 164 |
|
---|
| 165 | </sect2>
|
---|
| 166 |
|
---|
| 167 | </sect1>
|
---|