1260684SkaiwThe Elftoolchain Project 2260684Skaiw======================== 3260684Skaiw 4342916Semaste.. contents:: Table of Contents 5260684Skaiw 6260684SkaiwDescription 7260684Skaiw----------- 8260684Skaiw 9260684SkaiwThis software implements essential compilation tools and libraries for: 10260684Skaiw 11260684Skaiw- managing program objects conforming to the ELF_ object format, and 12260684Skaiw- for managing DWARF_ debugging information in ELF objects. 13260684Skaiw 14260684SkaiwThe project currently implements the following utilities and 15260684Skaiwlibraries: 16260684Skaiw 17342916Semaste=========== ============================================ 18342916SemasteName Description 19342916Semaste=========== ============================================ 20342916Semastear Archive manager. 21342916Semasteaddr2line Debug tool. 22342916Semastebrandelf Manage the ELF brand on executables. 23342916Semastec++filt Translate encoded symbols. 24342916Semasteelfcopy Copy and translate between object formats. 25342916Semasteelfdump Diagnostic tool. 26342916Semastefindtextrel Find undesired text relocations. 27342916Semastelibdwarf DWARF access library. 28342916Semastelibelf ELF access library. 29342916Semastemcs Manage comment sections. 30342916Semastenm List symbols in an ELF object. 31342916Semasteranlib Add archive symbol tables to an archive. 32342916Semastereadelf Display ELF information. 33342916Semastesize List object sizes. 34342916Semastestrings Extract printable strings. 35342916Semastestrip Discard information from ELF objects. 36342916Semaste=========== ============================================ 37260684Skaiw 38260684Skaiw.. _ELF: http://en.wikipedia.org/wiki/Executable_and_Linkable_Format 39260684Skaiw.. _DWARF: http://www.dwarfstd.org/ 40260684Skaiw 41260684Skaiw 42260684SkaiwProject Documentation 43260684Skaiw--------------------- 44260684Skaiw 45260684Skaiw- Release notes for released versions of this software are present in 46260684Skaiw the file ``RELEASE-NOTES`` in the current directory. 47260684Skaiw- The file ``INSTALL`` in the current directory contains instructions 48260684Skaiw on building and installing this software. 49260684Skaiw- Reference documentation in the form of manual pages is provided for 50260684Skaiw the utilities and libraries developed by the project. 51260684Skaiw- Additional tutorial documentation is present in the 52260684Skaiw ``documentation`` directory. 53260684Skaiw 54260684Skaiw 55260684SkaiwTracking Ongoing Development 56260684Skaiw---------------------------- 57260684Skaiw 58260684SkaiwThe project uses subversion_ for its version control system. 59260684Skaiw 60342916Semaste.. _subversion: https://subversion.apache.org/ 61342916Semaste 62260684SkaiwThe subversion branch for the current set of sources may be accessed 63342916Semasteat the following URL:: 64260684Skaiw 65367466Sdim https://sourceforge.net/p/elftoolchain/code/HEAD/tree/trunk/ 66260684Skaiw 67260684SkaiwThe project's source tree may be checked out from its repository by 68260684Skaiwusing the ``svn checkout`` command:: 69260684Skaiw 70367466Sdim % svn checkout https://svn.code.sf.net/p/elftoolchain/code/trunk 71260684Skaiw 72260684SkaiwChecked-out sources may be kept upto-date by running ``svn update`` 73260684Skaiwinside the source directory:: 74260684Skaiw 75342916Semaste % svn update 76260684Skaiw 77260684Skaiw 78260684SkaiwInstructions on building and installing the software are given in the 79260684Skaiwfile ``INSTALL`` in the current directory. 80260684Skaiw 81260684SkaiwDownloading Released Software 82260684Skaiw----------------------------- 83260684Skaiw 84260684SkaiwReleased versions of the project's software may also be downloaded 85260684Skaiwfrom SourceForge's `file release system`_. 86260684Skaiw 87260684Skaiw.. _file release system: http://sourceforge.net/projects/elftoolchain/files/ 88260684Skaiw 89260684SkaiwCopyright and License 90260684Skaiw--------------------- 91260684Skaiw 92260684SkaiwThis code is copyright its authors, and is distributed under the `BSD 93260684SkaiwLicense`_. 94260684Skaiw 95260684Skaiw.. _BSD License: http://www.opensource.org/licenses/bsd-license.php 96260684Skaiw 97260684Skaiw 98260684SkaiwDeveloper Community 99260684Skaiw------------------- 100260684Skaiw 101260684SkaiwThe project's developers may be contacted using the mailing list: 102260684Skaiw``<elftoolchain-developers@lists.sourceforge.net>``. 103260684Skaiw 104260684Skaiw 105260684SkaiwReporting Bugs 106260684Skaiw-------------- 107260684Skaiw 108367466SdimPlease use our `bug tracker`_ for viewing existing bug reports and 109260684Skaiwfor submitting new bug reports. 110260684Skaiw 111367466Sdim.. _`bug tracker`: https://sourceforge.net/p/elftoolchain/tickets/ 112260684Skaiw 113260684Skaiw 114260684SkaiwAdditional Information 115260684Skaiw---------------------- 116260684Skaiw 117260684SkaiwAdditional information about the project may be found on the `project 118260684Skaiwwebsite`_. 119260684Skaiw 120260684Skaiw.. _project website: http://elftoolchain.sourceforge.net/ 121260684Skaiw 122367466Sdim.. $Id: README.rst 3677 2019-02-11 09:37:09Z jkoshy $ 123260684Skaiw 124260684Skaiw.. Local Variables: 125260684Skaiw.. mode: rst 126260684Skaiw.. End: 127