Commit 7876df56 by devttys0

Updated INSTALL.md and README.md with new installation procedures

parent 62e25031
...@@ -6,13 +6,10 @@ Binwalk supports Python 2.7 - 3.x. The following installation procedures assume ...@@ -6,13 +6,10 @@ Binwalk supports Python 2.7 - 3.x. The following installation procedures assume
Installation Installation
============ ============
Installation follows the typical configure/make process (standard development tools such as gcc, make, and Python must be installed in order to build): Installation follows the typical Python installation procedure:
```bash ```bash
$ autoreconf $ sudo python setup.py install
$ ./configure
$ make
$ sudo make install
``` ```
Dependencies Dependencies
...@@ -58,63 +55,8 @@ $ git clone https://github.com/devttys0/sasquatch ...@@ -58,63 +55,8 @@ $ git clone https://github.com/devttys0/sasquatch
$ (cd sasquatch && make && sudo make install) $ (cd sasquatch && make && sudo make install)
``` ```
Bundled Software
================
For convenience, the following libraries are bundled with the binwalk source:
libmagic
By default, libmagic is not built or installed unless explicitly enabled during the build process:
```bash
$ ./configure --enable-libmagic
```
By default, it is assumed that the libmagic library is already installed to a standard system library location (e.g., `/usr/lib`, `/usr/local/lib`, etc) in order for binwalk to find it at run time.
**Note:** If the bundled libmagic library is not used, be aware that:
1. Some versions of libmagic have known bugs that are triggered by binwalk under some circumstances.
2. Minor version releases of libmagic may not be backwards compatible with each other and installation of the wrong version of libmagic may cause binwalk to fail to function properly.
3. Conversely, updating libmagic to a version that works with binwalk may cause other utilities that rely on libmagic to fail.
Currently, the following libmagic versions are known to work properly with binwalk (other versions may or may not work):
5.18
5.19
5.20
Specifying a Python Interpreter
===============================
The default python interpreter used during install is the system-wide `python` interpreter. A different interpreter (e.g., `python2`, `python3`) can be specified at build time:
```bash
$ ./configure --with-python=python3
```
Installing the IDA Plugin Installing the IDA Plugin
========================= =========================
If IDA is installed on your system, you may optionally install the IDA plugin by specifying the location of your IDA install directory at build time: If IDA is installed on your system, you may optionally install the binwalk IDA plugin by simply copying the `src/scripts/binida.py` file into IDA's `plugins` directory.
```bash
$ ./configure --with-ida=/home/user/ida-6.6
$ make ida
```
Or, simply copy the `src/scripts/binida.py` file into IDA's `plugins` directory.
Uninstallation
==============
The following command will remove binwalk from your system. Note that this will *not* remove manually installed packages or tools:
```bash
$ sudo make uninstall
```
...@@ -6,13 +6,10 @@ Binwalk is a fast, easy to use tool for analyzing, reverse engineering, and extr ...@@ -6,13 +6,10 @@ Binwalk is a fast, easy to use tool for analyzing, reverse engineering, and extr
Installation Installation
============ ============
Binwalk follows the standard Unix configure/make installation procedure: Binwalk follows the standard Python installation procedure:
```bash ```bash
$ autoreconf $ sudo python setup.py install
$ ./configure
$ make
$ sudo make install
``` ```
If you're running Python 2.x, you'll also want to install the Python lzma module: If you're running Python 2.x, you'll also want to install the Python lzma module:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment