1 The Elftoolchain Project
2 ========================
4 .. contents:: Table of Contents
9 This software implements essential compilation tools and libraries for:
11 - managing program objects conforming to the ELF_ object format, and
12 - for managing DWARF_ debugging information in ELF objects.
14 The project currently implements the following utilities and
17 =========== ============================================
19 =========== ============================================
22 brandelf Manage the ELF brand on executables.
23 c++filt Translate encoded symbols.
24 elfcopy Copy and translate between object formats.
25 elfdump Diagnostic tool.
26 findtextrel Find undesired text relocations.
27 libdwarf DWARF access library.
28 libelf ELF access library.
29 mcs Manage comment sections.
30 nm List symbols in an ELF object.
31 ranlib Add archive symbol tables to an archive.
32 readelf Display ELF information.
33 size List object sizes.
34 strings Extract printable strings.
35 strip Discard information from ELF objects.
36 =========== ============================================
38 .. _ELF: http://en.wikipedia.org/wiki/Executable_and_Linkable_Format
39 .. _DWARF: http://www.dwarfstd.org/
45 - Release notes for released versions of this software are present in
46 the file ``RELEASE-NOTES`` in the current directory.
47 - The file ``INSTALL`` in the current directory contains instructions
48 on building and installing this software.
49 - Reference documentation in the form of manual pages is provided for
50 the utilities and libraries developed by the project.
51 - Additional tutorial documentation is present in the
52 ``documentation`` directory.
55 Tracking Ongoing Development
56 ----------------------------
58 The project uses subversion_ for its version control system.
60 .. _subversion: https://subversion.apache.org/
62 The subversion branch for the current set of sources may be accessed
63 at the following URL::
65 https://elftoolchain.svn.sourceforge.net/svnroot/elftoolchain/trunk
67 The project's source tree may be checked out from its repository by
68 using the ``svn checkout`` command::
70 % svn checkout https://elftoolchain.svn.sourceforge.net/svnroot/elftoolchain/trunk
72 Checked-out sources may be kept upto-date by running ``svn update``
73 inside the source directory::
78 Instructions on building and installing the software are given in the
79 file ``INSTALL`` in the current directory.
81 Downloading Released Software
82 -----------------------------
84 Released versions of the project's software may also be downloaded
85 from SourceForge's `file release system`_.
87 .. _file release system: http://sourceforge.net/projects/elftoolchain/files/
92 This code is copyright its authors, and is distributed under the `BSD
95 .. _BSD License: http://www.opensource.org/licenses/bsd-license.php
101 The project's developers may be contacted using the mailing list:
102 ``<elftoolchain-developers@lists.sourceforge.net>``.
108 Please use our `Trac instance`_ for viewing existing bug reports and
109 for submitting new bug reports.
111 .. _`Trac instance`: http://sourceforge.net/apps/trac/elftoolchain/report
114 Additional Information
115 ----------------------
117 Additional information about the project may be found on the `project
120 .. _project website: http://elftoolchain.sourceforge.net/
122 .. $Id: README.rst 3656 2018-12-26 09:46:24Z jkoshy $