Commit 8bc5ebcd by devttys0

Updated INSTALL.md

parent 394f7021
BEFORE YOU START Before You Start
----------------------------------------- ================
Binwalk supports Python 2.7 - 3.x. Although binwalk is slightly faster in Python 3, Binwalk supports Python 2.7 - 3.x. Although binwalk is slightly faster in Python 3, the Python OpenGL bindings are still experimental for Python 3, so Python 2.7 is recommended.
the Python OpenGL bindings are still experimental for Python 3, so Python 2.7 is
recommended.
The following installation procedures assume that you are installing binwalk to The following installation procedures assume that you are installing binwalk to be run using Python 2.7. If you want to use binwalk in Python 3, some package
be run using Python 2.7. If you want to use binwalk in Python 3, some package
names and installation procedures may differ slightly. names and installation procedures may differ slightly.
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
-----------------------------------------
Installation follows the typical configure/make process (standard development tools
such as gcc, make, and Python must be installed in order to build):
$ ./configure $ ./configure
$ make $ make
$ sudo make install $ sudo make install
Binwalk's core features will work out of the box without any additional dependencies. Binwalk's core features will work out of the box without any additional dependencies. However, to take advantage of binwalk's graphing and extraction capabilities, multiple supporting utilities/packages need to be installed.
However, to take advantage of binwalk's graphing and extraction capabilities, multiple
supporting utilities/packages need to be installed.
To ease "dependency hell", a shell script named deps.sh is included which attempts to To ease "dependency hell", a shell script named `deps.sh` is included which attempts to install all required dependencies for Debian and RedHat based systems:
install all required dependencies for Debian and RedHat based systems:
$ ./deps.sh $ ./deps.sh
If you are running a different system, or prefer to install these dependencies manually, If you are running a different system, or prefer to install these dependencies manually, see the Dependencies section below.
see the DEPENDENCIES section below.
Dependencies
============
DEPENDENCIES The following dependencies are only required for optional binwalk features, such as file extraction and graphing capabilities. Unless otherwise specified, these dependencies are available from most Linux package managers.
-------------------------------------------
The following dependencies are only required for optional binwalk features, such as Binwalk uses [pyqtgraph](http://www.pyqtgraph.org) to generate graphs and visualizations; pyqtgraph requires the following Python modules:
file extraction and graphing capabilities. Unless otherwise specified, these
dependencies are available from most Linux package managers:
libqt4-opengl libqt4-opengl
python-opengl python-opengl
...@@ -49,25 +37,27 @@ dependencies are available from most Linux package managers: ...@@ -49,25 +37,27 @@ dependencies are available from most Linux package managers:
python-numpy python-numpy
python-scipy python-scipy
mtd-utils Binwalk relies on multiple external utilties in order to automatically extract/decompress files and data:
zlib1g-dev
liblzma-dev mtd-utils
ncompress zlib1g-dev
gzip liblzma-dev
bzip2 ncompress
tar gzip
arj bzip2
p7zip tar
p7zip-full arj
p7zip
cabextract
p7zip-full
openjdk-6-jdk openjdk-6-jdk
firmware-mod-kit [https://code.google.com/p/firmware-mod-kit] [firmware-mod-kit](https://code.google.com/p/firmware-mod-kit)
UNINSTALL Uninstallation
----------------------------------------- ==============
The following command will remove binwalk from your system. Note that this will *not* The following command will remove binwalk from your system. Note that this will *not* remove manually installed packages, or utilities installed via deps.sh:
remove utilities installed via deps.sh:
$ sudo make uninstall $ sudo make uninstall
...@@ -14,11 +14,11 @@ Binwalk follows the standard Unix configure/make installation procedure: ...@@ -14,11 +14,11 @@ Binwalk follows the standard Unix configure/make installation procedure:
$ make $ make
$ sudo make install $ sudo make install
For convenience, optional dependancies for automatic extraction and graphical visualizations can be installed by running the included `deps.sh` script: For convenience, optional dependencies for automatic extraction and graphical visualizations can be installed by running the included `deps.sh` script:
$ ./deps.sh $ ./deps.sh
If your system is not supported by deps.sh, or if you wish to manually install dependancies, see INSTALL.md. If your system is not supported by deps.sh, or if you wish to manually install dependencies, see INSTALL.md.
For advanced installation options, see INSTALL.md. For advanced installation options, see INSTALL.md.
......
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