README.md
1Description
2===========
3
4Binwalk is a fast, easy to use tool for analyzing, reverse engineering, and extracting firmware images.
5
6Installation
7============
8
9Binwalk follows the standard Python installation procedure:
10
11```bash
12$ sudo python setup.py install
13```
14
15If you're running Python 2.x, you'll also want to install the Python lzma module:
16
17```bash
18$ sudo apt-get install python-lzma
19```
20
21For instructions on installing optional dependencies, see [INSTALL.md](https://github.com/devttys0/binwalk/blob/master/INSTALL.md).
22
23
24Usage
25=====
26
27Basic usage is simple:
28
29```bash
30$ binwalk firmware.bin
31
32DECIMAL HEXADECIMAL DESCRIPTION
33--------------------------------------------------------------------------------
340 0x0 TRX firmware header, little endian, header size: 28 bytes, image size: 14766080 bytes, CRC32: 0x6980E553 flags: 0x0, version: 1
3528 0x1C LZMA compressed data, properties: 0x5D, dictionary size: 65536 bytes, uncompressed size: 5494368 bytes
362319004 0x23629C Squashfs filesystem, little endian, version 4.0, compression: xz, size: 12442471 bytes, 3158 inodes, blocksize: 131072 bytes, blocksize: 131072 bytes, created: 2014-05-21 22:38:47
37```
38
39For additional examples and descriptions of advanced options, see the [wiki](https://github.com/devttys0/binwalk/wiki).
40