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 gc-download-http "https://www.hboehm.info/gc/gc_source/gc-&gc-version;.tar.gz">
|
---|
8 | <!ENTITY gc-download-ftp " ">
|
---|
9 | <!ENTITY gc-md5sum "4878e629f482600f2060f30853c7b415">
|
---|
10 | <!ENTITY gc-size "1.1 MB">
|
---|
11 | <!ENTITY gc-buildsize "11 MB (with tests)">
|
---|
12 | <!ENTITY gc-time "0.2 SBU (with tests)">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="gc" xreflabel="GC-&gc-version;">
|
---|
16 | <?dbhtml filename="gc.html"?>
|
---|
17 |
|
---|
18 | <sect1info>
|
---|
19 | <date>$Date$</date>
|
---|
20 | </sect1info>
|
---|
21 |
|
---|
22 | <title>GC-&gc-version;</title>
|
---|
23 |
|
---|
24 | <indexterm zone="gc">
|
---|
25 | <primary sortas="a-GC">GC</primary>
|
---|
26 | </indexterm>
|
---|
27 |
|
---|
28 | <sect2 role="package">
|
---|
29 | <title>Introduction to GC</title>
|
---|
30 |
|
---|
31 | <para>
|
---|
32 | The <application>GC</application> package contains the Boehm-Demers-Weiser
|
---|
33 | conservative garbage collector, which can be used as a garbage collecting
|
---|
34 | replacement for the C malloc function or C++ new operator. It allows you
|
---|
35 | to allocate memory basically as you normally would, without explicitly
|
---|
36 | deallocating memory that is no longer useful. The collector automatically
|
---|
37 | recycles memory when it determines that it can no longer be otherwise
|
---|
38 | accessed. The collector is also used by a number of programming language
|
---|
39 | implementations that either use C as intermediate code, want to facilitate
|
---|
40 | easier interoperation with C libraries, or just prefer the simple
|
---|
41 | collector interface. Alternatively, the garbage collector may be used as a
|
---|
42 | leak detector for C or C++ programs, though that is not its primary goal.
|
---|
43 | </para>
|
---|
44 |
|
---|
45 | &lfs111_checked;
|
---|
46 |
|
---|
47 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
48 | <itemizedlist spacing="compact">
|
---|
49 | <listitem>
|
---|
50 | <para>
|
---|
51 | Download (HTTP): <ulink url="&gc-download-http;"/>
|
---|
52 | </para>
|
---|
53 | </listitem>
|
---|
54 | <listitem>
|
---|
55 | <para>
|
---|
56 | Download (FTP): <ulink url="&gc-download-ftp;"/>
|
---|
57 | </para>
|
---|
58 | </listitem>
|
---|
59 | <listitem>
|
---|
60 | <para>
|
---|
61 | Download MD5 sum: &gc-md5sum;
|
---|
62 | </para>
|
---|
63 | </listitem>
|
---|
64 | <listitem>
|
---|
65 | <para>
|
---|
66 | Download size: &gc-size;
|
---|
67 | </para>
|
---|
68 | </listitem>
|
---|
69 | <listitem>
|
---|
70 | <para>
|
---|
71 | Estimated disk space required: &gc-buildsize;
|
---|
72 | </para>
|
---|
73 | </listitem>
|
---|
74 | <listitem>
|
---|
75 | <para>
|
---|
76 | Estimated build time: &gc-time;
|
---|
77 | </para>
|
---|
78 | </listitem>
|
---|
79 | </itemizedlist>
|
---|
80 |
|
---|
81 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
82 | <para role="optional">
|
---|
83 | <xref linkend="libatomic_ops"/>
|
---|
84 | </para>
|
---|
85 |
|
---|
86 | <para condition="html" role="usernotes">
|
---|
87 | User Notes: <ulink url="&blfs-wiki;/gc"/>
|
---|
88 | </para>
|
---|
89 | </sect2>
|
---|
90 |
|
---|
91 | <sect2 role="installation">
|
---|
92 | <title>Installation of GC</title>
|
---|
93 |
|
---|
94 | <para>
|
---|
95 | Install <application>GC</application> by running the following commands:
|
---|
96 | </para>
|
---|
97 |
|
---|
98 | <screen><userinput>./configure --prefix=/usr \
|
---|
99 | --enable-cplusplus \
|
---|
100 | --disable-static \
|
---|
101 | --docdir=/usr/share/doc/gc-&gc-version; &&
|
---|
102 | make</userinput></screen>
|
---|
103 |
|
---|
104 | <para>
|
---|
105 | To test the results, issue: <command>make check</command>.
|
---|
106 | </para>
|
---|
107 |
|
---|
108 | <para>
|
---|
109 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
110 | </para>
|
---|
111 |
|
---|
112 | <screen role="root"><userinput>make install &&
|
---|
113 | install -v -m644 doc/gc.man /usr/share/man/man3/gc_malloc.3</userinput></screen>
|
---|
114 | </sect2>
|
---|
115 |
|
---|
116 | <sect2 role="commands">
|
---|
117 | <title>Command Explanations</title>
|
---|
118 |
|
---|
119 | <para>
|
---|
120 | <parameter>--docdir=/usr/share/doc/gc-&gc-version;</parameter>:
|
---|
121 | This option is used so the package will install the
|
---|
122 | documentation in a versioned directory.
|
---|
123 | </para>
|
---|
124 |
|
---|
125 | <para>
|
---|
126 | <parameter>--enable-cplusplus</parameter>: This parameter enables the
|
---|
127 | building and installing of the C++ library along with the standard
|
---|
128 | C library.
|
---|
129 | </para>
|
---|
130 |
|
---|
131 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
132 | href="../../xincludes/static-libraries.xml"/>
|
---|
133 |
|
---|
134 | </sect2>
|
---|
135 |
|
---|
136 | <sect2 role="content">
|
---|
137 | <title>Contents</title>
|
---|
138 |
|
---|
139 | <segmentedlist>
|
---|
140 | <segtitle>Installed Programs</segtitle>
|
---|
141 | <segtitle>Installed Libraries</segtitle>
|
---|
142 | <segtitle>Installed Directories</segtitle>
|
---|
143 |
|
---|
144 | <seglistitem>
|
---|
145 | <seg>
|
---|
146 | None
|
---|
147 | </seg>
|
---|
148 | <seg>
|
---|
149 | libcord.so,
|
---|
150 | libgc.so, and
|
---|
151 | libgccpp.so
|
---|
152 | </seg>
|
---|
153 | <seg>
|
---|
154 | /usr/include/gc and
|
---|
155 | /usr/share/doc/gc-&gc-version;
|
---|
156 | </seg>
|
---|
157 | </seglistitem>
|
---|
158 | </segmentedlist>
|
---|
159 |
|
---|
160 | <variablelist>
|
---|
161 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
162 | <?dbfo list-presentation="list"?>
|
---|
163 | <?dbhtml list-presentation="table"?>
|
---|
164 |
|
---|
165 | <varlistentry id="libcord">
|
---|
166 | <term><filename class="libraryfile">libcord.so</filename></term>
|
---|
167 | <listitem>
|
---|
168 | <para>
|
---|
169 | contains a tree-based string library
|
---|
170 | </para>
|
---|
171 | <indexterm zone="gc libcord">
|
---|
172 | <primary sortas="c-libcord">libcord.so</primary>
|
---|
173 | </indexterm>
|
---|
174 | </listitem>
|
---|
175 | </varlistentry>
|
---|
176 |
|
---|
177 | <varlistentry id="libgc">
|
---|
178 | <term><filename class="libraryfile">libgc.so</filename></term>
|
---|
179 | <listitem>
|
---|
180 | <para>
|
---|
181 | contains a C interface to the conservative garbage collector,
|
---|
182 | primarily designed to replace the C malloc function
|
---|
183 | </para>
|
---|
184 | <indexterm zone="gc libgc">
|
---|
185 | <primary sortas="c-libgc">libgc.so</primary>
|
---|
186 | </indexterm>
|
---|
187 | </listitem>
|
---|
188 | </varlistentry>
|
---|
189 |
|
---|
190 | <varlistentry id="libgccpp">
|
---|
191 | <term><filename class="libraryfile">libgccpp.so</filename></term>
|
---|
192 | <listitem>
|
---|
193 | <para>
|
---|
194 | contains a C++ interface to the conservative garbage collector
|
---|
195 | </para>
|
---|
196 | <indexterm zone="gc libgccpp">
|
---|
197 | <primary sortas="c-libgccpp">libgccpp.so</primary>
|
---|
198 | </indexterm>
|
---|
199 | </listitem>
|
---|
200 | </varlistentry>
|
---|
201 |
|
---|
202 | </variablelist>
|
---|
203 |
|
---|
204 | </sect2>
|
---|
205 |
|
---|
206 | </sect1>
|
---|