# readelf

**Repository Path**: ghosind/readelf

## Basic Information

- **Project Name**: readelf
- **Description**: A simple readelf program implementation.
- **Primary Language**: C
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-03-23
- **Last Updated**: 2023-05-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: elf

## README

# readelf

A simple ELF format inspect tool without any dependencies.

## Implemented Features

- ELF file header (with `-h` or `-a` options)
- ELF sections' header (with `-S` option)

## Getting Started

1. Clone this repo to local.

  ```sh
  # clone with https
  git clone https://github.com/ghosind/readelf.git
  # clone with ssh
  git clone git@github.com:ghosind/readelf.git
  ```

2. Run `make` to compile program.

  ```sh
  make
  ```

  > NOTE: You may need to install `automake` tools before run this command.

3. Run `bin/readelf` to inspect some elf-format files.

  ```sh
  ./bin/readelf -a <path_of_elf_format_file>
  ```

## Documentations and Resources

- [Portable Formats Specification, Version 1.1](https://www.cs.cmu.edu/afs/cs/academic/class/15213-f00/docs/elf.pdf)
- [readelf manual](https://man7.org/linux/man-pages/man1/readelf.1.html)
- [Implementation in binutils](https://sourceware.org/git/?p=binutils-gdb.git;a=blob;f=binutils/readelf.c)