INSTALL

Copyright (C) 2013-2021 Andrey Ponomarenko's ABI Laboratory
All rights reserved.


RELEASE INFORMATION

Project:           ABI Dumper
Version:           1.3
Date:              September 13, 2021


This file explains how to install and setup environment
for the tool in your computer.


Content:

   1. Requirements for Linux and FreeBSD
   2. Configure and Install
   3. Usage


1. REQUIREMENTS FOR LINUX AND FREEBSD
=====================================

   1. Perl 5 (5.8 or newer)
   2. Elfutils (eu-readelf)
   3. Vtable-Dumper (1.1 or newer)
   4. Binutils (objdump)
   5. Universal Ctags



2. CONFIGURE AND INSTALL
========================

   This command will install an abi-dumper program in the
   PREFIX/bin system directory:

     sudo make install prefix=PREFIX [/usr, /usr/local, ...]

2.1 Remove

     sudo make uninstall prefix=PREFIX



3. USAGE
========

   Dump ABI of a library:
   
     abi-dumper libTest.so -o ABI.dump
     
   Dump ABI of a kernel module:
   
     abi-dumper Module.ko.debug -o ABI.dump

   For advanced usage, see output of --help option



Enjoy!