1# libbacktrace 2A C library that may be linked into a C/C++ program to produce symbolic backtraces 3 4Initially written by Ian Lance Taylor <iant@golang.org>. 5 6This is version 1.0. 7It is likely that this will always be version 1.0. 8 9The libbacktrace library may be linked into a program or library and 10used to produce symbolic backtraces. 11Sample uses would be to print a detailed backtrace when an error 12occurs or to gather detailed profiling information. 13 14The libbacktrace library is provided under a BSD license. 15See the source files for the exact license text. 16 17The public functions are declared and documented in the header file 18backtrace.h, which should be #include'd by a user of the library. 19 20Building libbacktrace will generate a file backtrace-supported.h, 21which a user of the library may use to determine whether backtraces 22will work. 23See the source file backtrace-supported.h.in for the macros that it 24defines. 25 26As of January 2018, libbacktrace only supports ELF, PE/COFF, and XCOFF 27executables with DWARF debugging information. 28The library is written to make it straightforward to add support for 29other object file and debugging formats. 30 31The library relies on the C++ unwind API defined at 32https://itanium-cxx-abi.github.io/cxx-abi/abi-eh.html 33This API is provided by GCC. 34