contrib/elftoolchain/README

   1 The Elftoolchain Project
   2 ========================
   3
   4 .. contents::
   5 ..
   6
   7 Description
   8 -----------
   9
  10 This software implements essential compilation tools and libraries for:
  11
  12 - managing program objects conforming to the ELF_ object format, and
  13 - for managing DWARF_ debugging information in ELF objects.
  14
  15 The project currently implements the following utilities and
  16 libraries:
  17
  18     =========== ============================================
  19     Name        Description
  20     =========== ============================================
  21     ar          Archive manager.
  22     addr2line   Debug tool.
  23     brandelf    Manage the ELF brand on executables.
  24     c++filt     Translate encoded symbols.
  25     elfcopy     Copy and translate between object formats.
  26     elfdump     Diagnostic tool.
  27     findtextrel Find undesired text relocations.
  28     libdwarf    DWARF access library.
  29     libelf      ELF access library.
  30     mcs         Manage comment sections.
  31     nm          List symbols in an ELF object.
  32     ranlib      Add archive symbol tables to an archive.
  33     readelf     Display ELF information.
  34     size        List object sizes.
  35     strings     Extract printable strings.
  36     strip       Discard information from ELF objects.
  37     =========== ============================================
  38
  39 .. _ELF: http://en.wikipedia.org/wiki/Executable_and_Linkable_Format
  40 .. _DWARF: http://www.dwarfstd.org/
  41
  42
  43 Project Documentation
  44 ---------------------
  45
  46 - Release notes for released versions of this software are present in
  47   the file ``RELEASE-NOTES`` in the current directory.
  48 - The file ``INSTALL`` in the current directory contains instructions
  49   on building and installing this software.
  50 - Reference documentation in the form of manual pages is provided for
  51   the utilities and libraries developed by the project.
  52 - Additional tutorial documentation is present in the
  53   ``documentation`` directory.
  54
  55
  56 Tracking Ongoing Development
  57 ----------------------------
  58
  59 The project uses subversion_ for its version control system.
  60
  61 The subversion branch for the current set of sources may be accessed
  62 at the following URL:
  63
  64   https://elftoolchain.svn.sourceforge.net/svnroot/elftoolchain/trunk
  65
  66 The project's source tree may be checked out from its repository by
  67 using the ``svn checkout`` command::
  68
  69     % svn checkout https://elftoolchain.svn.sourceforge.net/svnroot/elftoolchain/trunk
  70
  71 Checked-out sources may be kept upto-date by running ``svn update``
  72 inside the source directory::
  73
  74    % svn update
  75
  76
  77 Instructions on building and installing the software are given in the
  78 file ``INSTALL`` in the current directory.
  79
  80 .. _Subversion:
  81
  82 Downloading Released Software
  83 -----------------------------
  84
  85 Released versions of the project's software may also be downloaded
  86 from SourceForge's `file release system`_.
  87
  88 .. _file release system: http://sourceforge.net/projects/elftoolchain/files/
  89
  90 Copyright and License
  91 ---------------------
  92
  93 This code is copyright its authors, and is distributed under the `BSD
  94 License`_.
  95
  96 .. _BSD License: http://www.opensource.org/licenses/bsd-license.php
  97
  98
  99 Developer Community
 100 -------------------
 101
 102 The project's developers may be contacted using the mailing list:
 103 ``<elftoolchain-developers@lists.sourceforge.net>``.
 104
 105
 106 Reporting Bugs
 107 --------------
 108
 109 Please use our `Trac instance`_ for viewing existing bug reports and
 110 for submitting new bug reports.
 111
 112 .. _`Trac instance`: http://sourceforge.net/apps/trac/elftoolchain/report
 113
 114
 115 Additional Information
 116 ----------------------
 117
 118 Additional information about the project may be found on the `project
 119 website`_.
 120
 121 .. _project website:  http://elftoolchain.sourceforge.net/
 122
 123 .. $Id: README 2146 2011-11-11 09:39:00Z jkoshy $
 124
 125 .. Local Variables:
 126 .. mode: rst
 127 .. End: