diff --git a/INSTALL b/INSTALL index 20998407..438d6b0d 100644 --- a/INSTALL +++ b/INSTALL @@ -9,6 +9,53 @@ are permitted in any medium without royalty provided the copyright notice and this notice are preserved. This file is offered as-is, without warranty of any kind. +Compilation environnement +========================= +testdisk uses several libraries if available: + + * libncurses - Required, TestDisk and PhotoRec use a text user interface, Ncurses library and development files must be available. + * Ext2fs library - Optional, used by TestDisk to list files from ext2/ext3/ext4 partition and by PhotoRec to be able to carve the free space from an ext2/ext3 partition instead of the whole partition + * EWF library - Optional, TestDisk and PhotoRec use it to access Expert Witness Compression Format files (ie Encase files) + * Iconv - Optional, used to handle unicode filenames + * Jpeg library - Optional, used by PhotoRec to improved JPEG recovery rate + * NTFS library - Optional, used by TestDisk to list files from NTFS partition + * Reiserfs library - Optional, used by TestDisk to list files from reiserfs partition + * zlib library - Optional, used by PhotoRec to decompress gzipped content + * Qt5 library - Optional, required for QPhotoRec and to update the configure script. + +Linux +----- + + * Debian/Ubuntu: `apt-get install -y build-essential e2fslibs-dev libncurses5-dev libncursesw5-dev ntfs-3g-dev libjpeg-dev uuid-dev zlib1g-dev qtbase5-dev qttools5-dev-tools pkg-config dh-autoreconf git' + * RHEL/CentOS 5: `yum install -y buildsys-build e2fsprogs-devel libjpeg-devel ncurses-devel ntfs-3g-devel zlib-devel' + * RHEL/CentOS 6 or later: `yum install -y @buildsys-build desktop-file-utils e2fsprogs-devel libewf-devel libjpeg-devel libuuid-devel ncurses-devel ntfs-3g-devel qt-devel zlib-devel' + * Fedora: `dnf install -y @buildsys-build desktop-file-utils e2fsprogs-devel libewf-devel libjpeg-devel libuuid-devel ncurses-devel ntfs-3g-devel qt-devel zlib-devel' + +Mac OS X +-------- + +Install Xcode + +Windows +------- + +cygwin +^^^^^^ + +Cygwin https://cygwin.com/ is a large collection of GNU and Open Source tools which provide functionality similar to a Linux distribution on Windows, it includes the gcc compiler. +A DLL (cygwin1.dll) provides substantial POSIX API functionality, such functions may be required by some libraries that TestDisk or PhotoRec can use. + +MinGW-w64 +^^^^^^^^^ + +MinGW-w64 https://mingw-w64.org/ is a free and open source software development environment for creating Microsoft Windows applications. It provides GCC for Windows 64 & 32 bits. + +Generating configure script +=========================== + + mkdir config + autoreconf --install -W all -I config + Basic Installation ==================