README revision 1.1 1 1.1 mrg The libbacktrace library
2 1.1 mrg Initially written by Ian Lance Taylor <iant (a] google.com>
3 1.1 mrg
4 1.1 mrg The libbacktrace library may be linked into a program or library and
5 1.1 mrg used to produce symbolic backtraces. Sample uses would be to print a
6 1.1 mrg detailed backtrace when an error occurs or to gather detailed
7 1.1 mrg profiling information.
8 1.1 mrg
9 1.1 mrg The libbacktrace library is provided under a BSD license. See the
10 1.1 mrg source files for the exact license text.
11 1.1 mrg
12 1.1 mrg The public functions are declared and documented in the header file
13 1.1 mrg backtrace.h, which should be #include'd by a user of the library.
14 1.1 mrg
15 1.1 mrg Building libbacktrace will generate a file backtrace-supported.h,
16 1.1 mrg which a user of the library may use to determine whether backtraces
17 1.1 mrg will work. See the source file backtrace-supported.h.in for the
18 1.1 mrg macros that it defines.
19 1.1 mrg
20 1.1 mrg As of September 2012, libbacktrace only supports ELF executables with
21 1.1 mrg DWARF debugging information. The library is written to make it
22 1.1 mrg straightforward to add support for other object file and debugging
23 1.1 mrg formats.
24