[3bbd5fe9] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!ENTITY gc-download-http "http://www.hpl.hp.com/personal/Hans_Boehm/gc/gc_source/gc&gc-version;.tar.gz">
|
---|
| 8 | <!ENTITY gc-download-ftp "ftp://ftp.fu-berlin.de/unix/linux/mirrors/gentoo/distfiles/gc&gc-version;.tar.gz">
|
---|
| 9 | <!ENTITY gc-md5sum "00bf95cdcbedfa7321d14e0133b31cdb">
|
---|
| 10 | <!ENTITY gc-size "752 KB">
|
---|
| 11 | <!ENTITY gc-buildsize "7.6 MB">
|
---|
| 12 | <!ENTITY gc-time "0.2 SBU">
|
---|
| 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="gc" xreflabel="GC-&gc-version;">
|
---|
| 16 | <?dbhtml filename="gc.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
[256ee72c] | 21 | <keywordset>
|
---|
| 22 | <keyword role="package">gc&gc-version;.tar</keyword>
|
---|
[22ac237] | 23 | <keyword role="ftpdir">gc</keyword>
|
---|
[256ee72c] | 24 | </keywordset>
|
---|
[3bbd5fe9] | 25 | </sect1info>
|
---|
| 26 |
|
---|
| 27 | <title>GC-&gc-version;</title>
|
---|
| 28 |
|
---|
| 29 | <indexterm zone="gc">
|
---|
| 30 | <primary sortas="a-GC">GC</primary>
|
---|
| 31 | </indexterm>
|
---|
| 32 |
|
---|
| 33 | <sect2 role="package">
|
---|
| 34 | <title>Introduction to GC</title>
|
---|
| 35 |
|
---|
| 36 | <para>The <application>GC</application> package contains the
|
---|
| 37 | Boehm-Demers-Weiser conservative garbage collector, which can be used as a
|
---|
| 38 | garbage collecting replacement for the C malloc function or C++ new
|
---|
| 39 | operator. It allows you to allocate memory basically as you normally would,
|
---|
| 40 | without explicitly deallocating memory that is no longer useful. The
|
---|
| 41 | collector automatically recycles memory when it determines that it can no
|
---|
| 42 | longer be otherwise accessed. The collector is also used by a number of
|
---|
| 43 | programming language implementations that either use C as intermediate
|
---|
| 44 | code, want to facilitate easier interoperation with C libraries, or just
|
---|
| 45 | prefer the simple collector interface. Alternatively, the garbage collector
|
---|
| 46 | may be used as a leak detector for C or C++ programs, though that is not
|
---|
| 47 | its primary goal.</para>
|
---|
| 48 |
|
---|
| 49 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 50 | <itemizedlist spacing="compact">
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>Download (HTTP): <ulink url="&gc-download-http;"/></para>
|
---|
| 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
| 55 | <para>Download (FTP): <ulink url="&gc-download-ftp;"/></para>
|
---|
| 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
| 58 | <para>Download MD5 sum: &gc-md5sum;</para>
|
---|
| 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
| 61 | <para>Download size: &gc-size;</para>
|
---|
| 62 | </listitem>
|
---|
| 63 | <listitem>
|
---|
| 64 | <para>Estimated disk space required: &gc-buildsize;</para>
|
---|
| 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
| 67 | <para>Estimated build time: &gc-time;</para>
|
---|
| 68 | </listitem>
|
---|
| 69 | </itemizedlist>
|
---|
| 70 |
|
---|
| 71 | </sect2>
|
---|
| 72 |
|
---|
| 73 | <sect2 role="installation">
|
---|
| 74 | <title>Installation of GC</title>
|
---|
| 75 |
|
---|
| 76 | <para>Install <application>GC</application> by running the following
|
---|
| 77 | commands:</para>
|
---|
| 78 |
|
---|
[4d2fd6f3] | 79 | <screen><userinput>sed -i "s|\$(datadir)/@PACKAGE@|&-&gc-version;|" doc/Makefile.in &&
|
---|
[3bbd5fe9] | 80 | ./configure --prefix=/usr \
|
---|
| 81 | --datadir=/usr/share/doc --enable-cplusplus &&
|
---|
| 82 | make</userinput></screen>
|
---|
| 83 |
|
---|
| 84 | <para>To test the results, issue: <command>make check</command>.</para>
|
---|
| 85 |
|
---|
| 86 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 87 |
|
---|
| 88 | <screen role="root"><userinput>make install &&
|
---|
| 89 | install -v -m644 doc/gc.man /usr/share/man/man3/gc_malloc.3 &&
|
---|
| 90 | ln -v -s gc_malloc.3 /usr/share/man/man3/gc.3</userinput></screen>
|
---|
| 91 |
|
---|
| 92 | </sect2>
|
---|
| 93 |
|
---|
| 94 | <sect2 role="commands">
|
---|
| 95 | <title>Command Explanations</title>
|
---|
| 96 |
|
---|
[4d2fd6f3] | 97 | <para><command>sed -i "s|\$(datadir)/@PACKAGE@|&-&gc-version;|" ...</command>:
|
---|
| 98 | This command appends <quote>-&gc-version;</quote> to the default documentation
|
---|
[3bbd5fe9] | 99 | installation path of
|
---|
| 100 | <filename class='directory'>/usr/share/doc/gc</filename>.</para>
|
---|
| 101 |
|
---|
| 102 | <para><parameter>--datadir=/usr/share/doc</parameter>: This parameter
|
---|
| 103 | changes the installation path of the documentation to
|
---|
| 104 | <filename class='directory'>/usr/share/doc/gc</filename> instead of
|
---|
| 105 | <filename class='directory'>/usr/share/gc</filename>.</para>
|
---|
| 106 |
|
---|
| 107 | <para><parameter>--enable-cplusplus</parameter>: This parameter forces
|
---|
| 108 | the building and installation of the C++ library along with the standard
|
---|
| 109 | C library.</para>
|
---|
| 110 |
|
---|
| 111 | </sect2>
|
---|
| 112 |
|
---|
| 113 | <sect2 role="content">
|
---|
| 114 | <title>Contents</title>
|
---|
| 115 |
|
---|
| 116 | <segmentedlist>
|
---|
| 117 | <segtitle>Installed Programs</segtitle>
|
---|
| 118 | <segtitle>Installed Libraries</segtitle>
|
---|
| 119 | <segtitle>Installed Directories</segtitle>
|
---|
| 120 |
|
---|
| 121 | <seglistitem>
|
---|
| 122 | <seg>None</seg>
|
---|
| 123 | <seg>libgc.[so,a] and libgccpp.[so,a]</seg>
|
---|
| 124 | <seg>/usr/include/gc and /usr/share/doc/gc-&gc-version;</seg>
|
---|
| 125 | </seglistitem>
|
---|
| 126 | </segmentedlist>
|
---|
| 127 |
|
---|
| 128 | <variablelist>
|
---|
| 129 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 130 | <?dbfo list-presentation="list"?>
|
---|
| 131 | <?dbhtml list-presentation="table"?>
|
---|
| 132 |
|
---|
| 133 | <varlistentry id="libgc">
|
---|
| 134 | <term><filename class='libraryfile'>libgc.[so,a]</filename></term>
|
---|
| 135 | <listitem>
|
---|
| 136 | <para>contains a C interface to the conservative garbage collector,
|
---|
| 137 | primarily designed to replace the C malloc function.</para>
|
---|
| 138 | <indexterm zone="gc libgc">
|
---|
| 139 | <primary sortas="c-libgc">libgc.[so,a]</primary>
|
---|
| 140 | </indexterm>
|
---|
| 141 | </listitem>
|
---|
| 142 | </varlistentry>
|
---|
| 143 |
|
---|
| 144 | <varlistentry id="libgccpp">
|
---|
| 145 | <term><filename class='libraryfile'>libgccpp.[so,a]</filename></term>
|
---|
| 146 | <listitem>
|
---|
| 147 | <para>contains a C++ interface to the conservative garbage
|
---|
| 148 | collector.</para>
|
---|
| 149 | <indexterm zone="gc libgccpp">
|
---|
| 150 | <primary sortas="c-libgccpp">libgccpp.[so,a]</primary>
|
---|
| 151 | </indexterm>
|
---|
| 152 | </listitem>
|
---|
| 153 | </varlistentry>
|
---|
| 154 |
|
---|
| 155 | </variablelist>
|
---|
| 156 |
|
---|
| 157 | </sect2>
|
---|
| 158 |
|
---|
| 159 | </sect1>
|
---|