diff --git a/doc/tutorial.docbook b/doc/elfio.docbook similarity index 100% rename from doc/tutorial.docbook rename to doc/elfio.docbook diff --git a/doc/tutorial.html b/doc/elfio.html similarity index 95% rename from doc/tutorial.html rename to doc/elfio.html index 17280c2..deb5cff 100644 --- a/doc/tutorial.html +++ b/doc/elfio.html @@ -1,6 +1,6 @@ -ELFIO

ELFIO

User's Guide

Serge Lamikhov-Center

Table of Contents

Introduction
1. Getting Started With ELFIO
ELF File Reader
ELF Section Data Accessors
ELFDump Utility
ELF File Writer
2. ELFIO Library Classes
Class elfio
Data members
Member functions
3. +ELFIO

ELFIO

User's Guide

Serge Lamikhov-Center

Table of Contents

Introduction
1. Getting Started With ELFIO
ELF File Reader
ELF Section Data Accessors
ELFDump Utility
ELF File Writer
2. ELFIO Library Classes
Class elfio
Data members
Member functions
3. IELFO - ELF File Producer Interface -

List of Tables

2.1. Class elfio member functions
2.2. Class elfio member functions
2.3. Class elfio member functions (continue)

Introduction

+

List of Tables

2.1. Class elfio member functions
2.2. Class elfio member functions
2.3. Class elfio member functions (continue)

Introduction

ELFIO is a C++ library for reading and generating files in ELF binary format. This library is independent and does not require any other product. It is also cross-platform - the library uses standard ANSI C++ constructions @@ -9,7 +9,7 @@ While the library's implementation does make your work much easier: basic knowledge of the ELF binary format is required. Information about ELF format can be found widely on the web. -

Chapter 1. Getting Started With ELFIO

Table of Contents

ELF File Reader
ELF Section Data Accessors
ELFDump Utility
ELF File Writer

ELF File Reader

+

Chapter 1. Getting Started With ELFIO

Table of Contents

ELF File Reader
ELF Section Data Accessors
ELFDump Utility
ELF File Writer

ELF File Reader

The ELFIO library is a header only library. No preparatory compilation steps are required. To make your application be aware about the ELFIO classes and types declarations, just include elfio.hpp header file. @@ -146,7 +146,7 @@ int main( int argc, char** argv )

The full text of this example comes together with ELFIO library distribution. -

ELF Section Data Accessors

+

ELF Section Data Accessors

To simplify creation and interpretation of the ELF sections' data, the ELFIO library comes with auxiliary classes - accessors. To the moment of this document writing, the following accessors are available: @@ -188,20 +188,20 @@ int main( int argc, char** argv ) section* parameters for their constructors. get_symbol is used to retrieve a particular entry in the symbol table. -

ELFDump Utility

+

ELFDump Utility

The source code for the ELF Dumping Utility can be found in the "Examples" directory; included there are more examples on how to use different ELFIO reader interfaces. -

ELF File Writer

+

ELF File Writer

The ELFIO library is a header only library. No preparatory compilation steps are required. To make your application be aware about the ELFIO classes and types declarations, just include elfio.hpp header file. All ELFIO library declarations reside in ELFIO namespace. So, our tutorial code starts from this: -

Chapter 2. ELFIO Library Classes

Table of Contents

Class elfio
Data members
Member functions

Class elfio

Data members

+

Chapter 2. ELFIO Library Classes

Table of Contents

Class elfio
Data members
Member functions

Class elfio

Data members

The ELFIO library consists of two independent parts: ELF File Reader

-

Table 2.1. Class elfio member functions

FunctionDescription
+

Table 2.1. Class elfio member functions

FunctionDescription
sections A container that stores pointers to ELF file section instances. @@ -216,7 +216,7 @@ int main( int argc, char** argv ) Returns true if the file was processed successfully.


-

Member functions

+

Member functions

The ELFIO library consists of two independent parts: ELF File Reader (IELFI) and ELF Producer (IELFO). @@ -225,7 +225,7 @@ int main( int argc, char** argv ) instantiated. ELFIO itself provides the interfaces that are used to access the library's functionality.

-

Table 2.2. Class elfio member functions

FunctionDescription
+

Table 2.2. Class elfio member functions

FunctionDescription
elfio (); 
 
@@ -355,7 +355,7 @@ int main( int argc, char** argv )


-

Table 2.3. Class elfio member functions (continue)

FunctionDescription
+

Table 2.3. Class elfio member functions (continue)

FunctionDescription
Elf64_Addr get_entry (); 
 
 diff --git a/doc/elfio.pdf b/doc/elfio.pdf new file mode 100644 index 0000000..855a4a0 Binary files /dev/null and b/doc/elfio.pdf differ diff --git a/doc/site/index.htm b/doc/site/index.htm index b5382eb..fb05ee2 100755 --- a/doc/site/index.htm +++ b/doc/site/index.htm @@ -22,7 +22,7 @@
  • Download the source

  • Read the User's Guide

  • Read the API documentation

    • -
  • Visit the +
  • Visit the SourceForge project page

  • Old documentation for outdated 1.0.3 version of the library

  • Send feedback, comments, patches, etc.

    • @@ -46,16 +46,16 @@ knowledge of the ELF binary format is required. Information about ELF binary format can be found widely on the web.

    -Current version of ELFIO library is 2.0 and it is distributed under +Current version of ELFIO library is 2.0 and it is distributed under MIT License conditions.

    -Note for users of previous library versions 1.0.x - Version 2.0 is not source +Note for users of previous library versions 1.0.x: Version 2.0 is not source compatible to earlier versions. But, for many projects, transition to a new library interface does not take more than several minutes.

    - +

    @@ -78,7 +78,7 @@ Project Web Hosted by

    - +