.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH ABI-DUMPER "1" "February 2023" "ABI Dumper 1.2" "User Commands"
.SH NAME
abi-dumper \- a tool to dump ABI of an ELF object containing DWARF debug info
.SH DESCRIPTION
.SS "NAME:"
.IP
ABI Dumper (abi\-dumper)
Dump ABI of an ELF object containing DWARF debug info
.SS "DESCRIPTION:"
.IP
ABI Dumper is a tool for dumping ABI information of an ELF object
containing DWARF debug info.
.IP
The tool is intended to be used with ABI Compliance Checker tool for
tracking ABI changes of a C/C++ library or kernel module.
.IP
This tool is free software: you can redistribute it and/or modify it
under the terms of the GNU LGPL 2.1.
.SS "USAGE:"
.IP
abi\-dumper [options] [object]
.SS "EXAMPLES:"
.IP
abi\-dumper libTest.so \fB\-o\fR ABI.dump
.IP
abi\-dumper Module.ko.debug \fB\-o\fR ABI.dump
.SS "INFORMATION OPTIONS:"
.HP
\fB\-h\fR|\-help
.IP
Print this help.
.HP
\fB\-v\fR|\-version
.IP
Print version information.
.HP
\fB\-dumpversion\fR
.IP
Print the tool version (1.2) and don't do anything else.
.SS "GENERAL OPTIONS:"
.HP
\fB\-o\fR|\-output PATH
.IP
Path to the output ABI dump file.
Default: ./ABI.dump
.HP
\fB\-sort\fR
.IP
Sort data in ABI dump.
.HP
\fB\-stdout\fR
.IP
Print ABI dump to stdout.
.HP
\fB\-loud\fR
.IP
Print all warnings.
.HP
\fB\-vnum\fR NUM
.IP
Set version of the library to NUM.
.HP
\fB\-extra\-info\fR DIR
.IP
Dump extra analysis info to DIR.
.HP
\fB\-bin\-only\fR
.IP
Do not dump information about inline functions,
pure virtual functions and non\-exported global data.
.HP
\fB\-all\-types\fR
.IP
Dump unused data types.
.HP
\fB\-all\-symbols\fR
.IP
Dump symbols not exported by the object.
.HP
\fB\-symbols\-list\fR PATH
.IP
Specify a file with a list of symbols that should be dumped.
.HP
\fB\-skip\-cxx\fR
.IP
Do not dump stdc++ and gnu c++ symbols.
.HP
\fB\-all\fR
.IP
Equal to: \fB\-all\-types\fR \fB\-all\-symbols\fR.
.HP
\fB\-dump\-static\fR
.IP
Dump static (local) symbols.
.HP
\fB\-compare\fR OLD.dump NEW.dump
.IP
Show added/removed symbols between two ABI dumps.
.HP
\fB\-alt\fR PATH
.IP
Path to the alternate debug info (Fedora). It is
detected automatically from gnu_debugaltlink section
of the input object if not specified.
.HP
\fB\-dir\fR
.IP
Show full paths of source files.
.HP
\fB\-vt\-dumper\fR PATH
.IP
Path to the vtable\-dumper executable if it is installed
to non\-default location (not in PATH).
.HP
\fB\-public\-headers\fR PATH
.IP
Path to directory with public header files or to file with
the list of header files. This option allows one to filter out
private symbols from the ABI dump.
.HP
\fB\-ignore\-tags\fR PATH
.IP
Path to ignore.tags file to help ctags tool to read
symbols in header files.
.HP
\fB\-ctags\-def\fR DEF
.IP
Add \fB\-D\fR DEF option to the ctags call. This option may be
specified multiple times.
.HP
\fB\-reimplement\-std\fR
.IP
Do nothing.
.HP
\fB\-mixed\-headers\fR
.IP
This option should be specified if you are using
\fB\-public\-headers\fR option and the names of public headers
intersect with the internal headers.
.HP
\fB\-kernel\-export\fR
.IP
Dump symbols exported by the Linux kernel and modules, i.e.
symbols declared in the ksymtab section of the object and
system calls.
.HP
\fB\-search\-debuginfo\fR DIR
.IP
Search for debug\-info files referenced from gnu_debuglink
section of the object in DIR.
.HP
\fB\-keep\-registers\-and\-offsets\fR
.IP
Dump used registers and stack offsets even if incompatible
build options detected.
.HP
\fB\-all\-units\fR
.IP
Extract ABI info after reading all compilation units from
the debug info. This may require a lot of extra RAM memory.
By default all compilation units are processed separately.
.HP
\fB\-quiet\fR
.IP
Do not warn about incompatible build options.
.HP
\fB\-debug\fR
.IP
Enable debug messages.
.SS "EXTRA OPTIONS:"
.HP
\fB\-use\-tu\-dump\fR
.IP
Use g++ \fB\-fdump\-translation\-unit\fR instead of ctags to
list symbols in headers. This may be useful if all
functions are declared via macros in headers and
ctags can't recognize them.
.HP
\fB\-include\-preamble\fR PATHS
.IP
Specify header files (separated by semicolon) that
should be included before others to compile without
errors.
.HP
\fB\-include\-paths\fR DIRS
.IP
Specify include directories (separated by semicolon)
that should be passed to the compiler by \fB\-I\fR option
in order to compile headers without errors. If this
option is not set then the tool will try to generate
include paths automatically.
.HP
\fB\-cache\-headers\fR DIR
.IP
Cache headers analysis results to reuse later.
.HP
\fB\-lambda\fR
.IP
Enable support for lambda and checking of lexical
blocks. Define it if your C++ library API functions
use lambda expressions.
.HP
\fB\-ld\-library\-path\fR PATHS
.IP
Specify paths to add to LD_LIBRARY_PATH variable before
executing vtable\-dumper (separated by colon).
.IP
By default lexical blocks are not analyzed to
improve performance.
.SH AUTHOR
This manual page was written by Mathieu Malaterre <malat@debian.org> for the
Debian GNU/Linux system (but may be used by others).
.PP
Written by Andrey Ponomarenko.
.SH COPYRIGHT
Copyright \(co 2019 Andrey Ponomarenko's ABI Laboratory
License: GNU LGPL 2.1 <http://www.gnu.org/licenses/>
This program is free software: you can redistribute it and/or modify it.