Skip to content

add linux and Mac OS X compilation guide to README #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

add linux and Mac OS X compilation guide to README #16

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 27 additions & 6 deletions README
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,18 +57,36 @@ simply uncomment all file carving patterns; this wastes time and will
generate a huge number of false positives. Instead, uncomment only
the patterns for the file types you need.

To run scalpel, "scalpel.conf" must be specified in the current working
direcotry.

Scalpel options are described in the Scalpel man page, "scalpel.1".
You may also execute Scalpel w/o any command line arguments to see a
list of options.

NOTE: Compilation is necessary on Unix platforms and on Mac OS X. For
Windows platforms, a precompiled scalpel.exe is provided. If you do

COMPILATION PREREQUISITES:

NOTE: Compilation is necessary on Unix platforms and on Mac OS X.

o For Mac OS X, these four package is needed for build dependencies -
autoconf, automake, libtool, tre. You can install these package through
homebrew by running `brew install autoconf automake libtool tre`.

o For Linux, these package is required - make, autoconf, automake,
libtool, tre. Use any method to install these package. If you are using
Debian-like linux, you can install them through `apt-get` by running
`apt-get install make autoconf automake libtool tre-agrep libtre5
libtre-dev`.

o For Windows platforms, a precompiled scalpel.exe is provided. If you do
wish to recompile Scalpel on Windows, you'll need a mingw (gcc)
setup. Scalpel will not compile using Visual Studio C compilers. Note
that our compilation environment for Windows is currently 32-bit; we
haven't tested on the 64-bit version of mingw, but will address this
int the future.


COMPILE INSTRUCTIONS ON SUPPORTED PLATFORMS:

Linux/Mac OS X:
Expand Down Expand Up @@ -117,10 +135,13 @@ replaced with a more robust facility in the next major release.

DEPENDENCIES:

Scalpel uses the POSIX threads library. On Win32, Scalpel is
distributed with the Pthreads-win32 - POSIX Threads Library for Win32,
which is Copyright(C) 1998 John E. Bossom and Copyright(C) 1999,2005
by Pthreads-win32 contributors. This library is licensed under the LGPL.
Scalpel uses the POSIX threads library and depends on the POSIX
compliant regexp matching library `tre`.

On Win32, Scalpel is distributed with the Pthreads-win32 - POSIX Threads
Library for Win32, which is Copyright(C) 1998 John E. Bossom and
Copyright(C) 1999,2005 by Pthreads-win32 contributors. This library
is licensed under the LGPL.

Scalpel for Win32 uses the tre regular expression library and is
distributed with tre-0.7.5, which is licensed under the LGPL.
Expand Down