• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1The elfutils documentation is very much a work in
2progress. Contributions are welcome.
3Please reports bugs at https://sourceware.org/bugzilla/
4Please send additions and patches to: elfutils-devel@sourceware.org
5
6The elfutils utilities are a new implementation of many of the
7utilities found in binutils and consequently, the documentation for
8most of the tools has been the the man pages for binutils. For example
9you could refer to readelf's man page for instructions on
10eu-readelf. This has been fine up until this point but as tools gain
11new capabilities, they will need to have their own individual man
12page. Forking the man pages from binutils is acceptable and the
13current plan of action.
14
15New utilities that do not have an analog in binutils can have their
16initial man pages generated using a tool like help2man.
17
18The C language interfaces for libelf, libdw, and libdwfl are in
19particular need of documentation. The aspirational goal is write these
20in sphinx.