aboutsummaryrefslogtreecommitdiffstats
path: root/archive/gamin.xml
blob: 3032b0ded8f51aef757be80d7c633a3484034972 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY gamin-download-http
    "http://www.gnome.org/~veillard/gamin/sources/gamin-&gamin-version;.tar.gz">
  <!ENTITY gamin-download-ftp  "&gentoo-ftp-repo;/gamin-&gamin-version;.tar.gz">
  <!ENTITY gamin-md5sum        "b4ec549e57da470c04edd5ec2876a028">
  <!ENTITY gamin-size          "639 KB">
  <!ENTITY gamin-buildsize     "6.7 MB">
  <!ENTITY gamin-time          "0.1 SBU">
]>

<sect1 id="gamin" xreflabel="Gamin-&gamin-version;">
  <?dbhtml filename="gamin.html"?>


  <title>Gamin-&gamin-version;</title>

  <indexterm zone="gamin">
    <primary sortas="a-Gamin">Gamin</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Gamin</title>

    <para>
      The <application>Gamin</application> package contains a File Alteration
      Monitor which is useful for notifying applications of changes to the file
      system. Gamin is compatible with
      <ulink url="http://oss.sgi.com/projects/fam/">FAM</ulink>.
    </para>

    &lfs74_built;

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

    <bridgehead renderas="sect3">Gamin Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="glib2"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="python2"/>
    </para>

    <para condition="html" role="usernotes">
      User Notes: <ulink url="&blfs-wiki;/gamin"/>
    </para>
  </sect2>

  <sect2 role="installation">
    <title>Installation of Gamin</title>

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

<screen><userinput>sed -i 's/G_CONST_RETURN/const/' server/gam_{node,subscription}.{c,h} &amp;&amp;
./configure --prefix=/usr --libexecdir=/usr/sbin --disable-static &amp;&amp;
make</userinput></screen>

    <para>
      To test the results, issue: <command>make check</command>. Note that some
      tests may display errors.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make install &amp;&amp;
install -v -m755 -d /usr/share/doc/gamin-&gamin-version; &amp;&amp;
install -v -m644 doc/*.{html,fig,gif,txt} /usr/share/doc/gamin-&gamin-version;</userinput></screen>
  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <command>sed -i 's/G_CONST_RETURN/const/'
      server/gam_{node,subscription}.{c,h}</command>: This sed fixes compiling
      with <application>Glib 2.32</application> or greater installed.
    </para>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/static-libraries.xml"/>
  </sect2>

  <sect2 role="configuration">
    <title>Configuring Gamin</title>

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

      <para>
        No configuration is generally required and the default options should
        work for most users. See
        <ulink url="http://www.gnome.org/~veillard/gamin/config.html"/> for
        details.
      </para>
    </sect3>
  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>gam_server</seg>
        <seg>
          libfam.so, libgamin-1.so, libgamin_shared.a and (if you've installed
          <application>Python 2</application>) _gamin.so.
        </seg>
        <seg>/usr/share/doc/gamin-&gamin-version;</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

    <varlistentry id="gam_server">
      <term><command>gam_server</command></term>
      <listitem>
        <para>
          is the file alteration monitor daemon that is started on demand for
          each user.
        </para>
        <indexterm zone="gamin gam_server">
          <primary sortas="b-gam_server">gam_server</primary>
        </indexterm>
      </listitem>
    </varlistentry>

    <varlistentry id="libgamin">
      <term><filename class='libraryfile'>libgamin.so</filename></term>
      <listitem>
        <para>
          contains functions that support the file allocation monitor.
        </para>
        <indexterm zone="gamin libgamin">
          <primary sortas="c-libgamin">libgamin.so</primary>
        </indexterm>
      </listitem>
    </varlistentry>

    <varlistentry id="libfam">
      <term><filename class='libraryfile'>libfam.so</filename></term>
      <listitem>
        <para>
          contains functions that provide compatibility with FAM.
        </para>
        <indexterm zone="gamin libfam">
          <primary sortas="c-libfam">libfam.so</primary>
        </indexterm>
      </listitem>
    </varlistentry>
    </variablelist>
  </sect2>
</sect1>