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