From cc7f97cd2931bf65f68754031681f1a1e20046fa Mon Sep 17 00:00:00 2001 From: Christophe Grenier Date: Wed, 24 Feb 2016 20:27:08 +0100 Subject: [PATCH] Split README into README.md and README_dev_photorec.txt --- Makefile.am | 6 +- README | 134 ---------------------------------------- README.md | 73 ++++++++++++++++++++++ README_dev_photorec.txt | 58 +++++++++++++++++ configure.ac | 2 +- 5 files changed, 134 insertions(+), 139 deletions(-) delete mode 100644 README create mode 100644 README.md create mode 100644 README_dev_photorec.txt diff --git a/Makefile.am b/Makefile.am index 88d74838..333370da 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,6 +1,6 @@ SUBDIRS = icons man src -EXTRA_DIST = AUTHORS COPYING ChangeLog INFO INSTALL NEWS README THANKS compile.sh \ +EXTRA_DIST = AUTHORS COPYING ChangeLog INFO INSTALL NEWS README.md README_dev_photorec.txt THANKS compile.sh \ progsreiserfs-journal.patch progsreiserfs-file-read.patch \ darwin/readme_mac_powerpc.txt darwin/readme_mac_intel.txt \ documentation.html \ @@ -22,11 +22,9 @@ EXTRA_DIST = AUTHORS COPYING ChangeLog INFO INSTALL NEWS README THANKS compile.s win/testdisk_win.exe.manifest \ Android.mk jni/Android.mk -AUTOMAKE_OPTIONS = gnits - install-data-hook: $(mkinstalldirs) $(DESTDIR)$(docdir) - $(INSTALL_DATA) $(top_srcdir)/AUTHORS $(top_srcdir)/ChangeLog $(top_srcdir)/NEWS $(top_srcdir)/README $(top_srcdir)/THANKS $(top_srcdir)/documentation.html $(DESTDIR)$(docdir) + $(INSTALL_DATA) $(top_srcdir)/AUTHORS $(top_srcdir)/ChangeLog $(top_srcdir)/NEWS $(top_srcdir)/README.md $(top_srcdir)/THANKS $(top_srcdir)/documentation.html $(DESTDIR)$(docdir) if USEQT $(mkinstalldirs) $(DESTDIR)$(datadir)/applications $(INSTALL_DATA) $(top_srcdir)/linux/qphotorec.desktop $(DESTDIR)$(datadir)/applications diff --git a/README b/README deleted file mode 100644 index 9c0932e0..00000000 --- a/README +++ /dev/null @@ -1,134 +0,0 @@ -TestDisk checks the partition and boot sectors of your disks. -It is very useful in recovering lost partitions. - -It works with : -- DOS/Windows FAT12, FAT16 and FAT32 -- NTFS ( Windows NT/2K/XP ) -- Linux Ext2 and Ext3 -- BeFS ( BeOS ) -- BSD disklabel ( FreeBSD/OpenBSD/NetBSD ) -- CramFS (Compressed File System) -- HFS and HFS+, Hierarchical File System -- JFS, IBM's Journaled File System -- Linux Raid -- Linux Swap (versions 1 and 2) -- LVM and LVM2, Linux Logical Volume Manager -- Netware NSS -- ReiserFS 3.5, 3.6 and 4 -- Sun Solaris i386 disklabel -- UFS and UFS2 (Sun/BSD/...) -- XFS, SGI's Journaled File System - -PhotoRec is file data recovery software designed to recover -lost pictures from digital camera memory or even Hard Disks. -It has been extended to search also for non audio/video headers. -It searches for -- Sun/NeXT audio data (.au) -- RIFF audio/video (.avi/.wav) -- BMP bitmap (.bmp) -- bzip2 compressed data (.bz2) -- Source code written in C (.c) -- Canon Raw picture (.crw) -- Canon catalog (.ctg) -- FAT subdirectory -- Microsoft Office Document (.doc) -- Nikon dsc (.dsc) -- HTML page (.html) -- JPEG picture (.jpg) -- MOV video (.mov) -- MP3 audio (MPEG ADTS, layer III, v1) (.mp3) -- Moving Picture Experts Group video (.mpg) -- Minolta Raw picture (.mrw) -- Olympus Raw Format picture (.orf) -- Portable Document Format (.pdf) -- Perl script (.pl) -- Portable Network Graphics (.png) -- Raw Fujifilm picture (.raf) -- Contax picture (.raw) -- Rollei picture (.rdc) -- Rich Text Format (.rtf) -- Shell script (.sh) -- Tar archive (.tar ) -- Tag Image File Format (.tiff) -- Microsoft ASF (.wma) -- Sigma/Foveon X3 raw picture (.x3f) -- zip archive (.zip) - -TestDisk and PhotoRec run under: -- Dos, Win9x -- Windows (NT 4/2000/XP/2003) -- Linux -- FreeBSD, NetBSD, OpenBSD -- SunOS - -Both are under GNU General Public License. - -Christophe GRENIER -grenier@cgsecurity.org -http://www.cgsecurity.org/ - -================================================================ -PhotoRec - Theory of operation: - -Carvers are plugable. Each carver consists of: - -struct file_hint_t - describes extension, name, max size, enable by default, etc. -file_enable_t list_file_enable[] - array with all file hints and whether enabled or not. - - -phmain.c - Contains the main() and driver logic for photorec. - -main(): - - reads parameters - - scans for available devices - - parses the HD (or image) - - resets the list of which file carvers are enabled - - Initializes ncurses - - Calls do_curses_photorec() (in pdisksel.c) - - shuts down ncurses - - -pdisksel.c - - int do_curses_photorec(int verbose, const char *recup_dir, const list_disk_t *list_disk, - file_enable_t *file_enable, char *cmd_device, char **current_cmd) - - - runs either photorec_disk_selection_cli() or photorec_disk_selection_ncurses() - - Both of these eventually call menu_photorec() in ppartsel.c - -ppartsel.c - menu_photorec(): - - Implements Search/Options/File Opt/Geometry/Quit menu - - Search Option: - - Creates new recup_dir - - Runs ext2_fix_group and ext2_fix_inode if necessary - - runs photorec() - -phrecn.c - photorec() - - runs multiple passes until status==STATUS_QUIT - - calls photorec_mkdir() to actually make the output directory - -photorec.c: - file_finish() - - called when file is done. - - called by: - - photorec_bf() - - photorec_bf_pad() - - photorec_bf_frag() - - photorec_bf_aux() - - file_recovery_t *file_recovery - - -photorec.c - file_finish2() - - called when a file is done. - - called by: - - photorec_aux() (in three places) - - photorec() - -Some utility functions: -phbf.c - set_filename(file_recovery,recup_dir,dir_num,disk_car,partition,nn) - - Figures out a file name - -================================================================ -XML Report Integration - -xml output file is always made and always placed in recup_dir diff --git a/README.md b/README.md new file mode 100644 index 00000000..a90f6fe7 --- /dev/null +++ b/README.md @@ -0,0 +1,73 @@ +**TestDisk** checks the partition and boot sectors of your disks. +It is very useful in recovering lost partitions. + +It works with : + +- DOS/Windows FAT12, FAT16 and FAT32 +- NTFS ( Windows NT/2K/XP ) +- Linux Ext2 and Ext3 +- BeFS ( BeOS ) +- BSD disklabel ( FreeBSD/OpenBSD/NetBSD ) +- CramFS (Compressed File System) +- HFS and HFS+, Hierarchical File System +- JFS, IBM's Journaled File System +- Linux Raid +- Linux Swap (versions 1 and 2) +- LVM and LVM2, Linux Logical Volume Manager +- Netware NSS +- ReiserFS 3.5, 3.6 and 4 +- Sun Solaris i386 disklabel +- UFS and UFS2 (Sun/BSD/...) +- XFS, SGI's Journaled File System + +**PhotoRec** is file data recovery software designed to recover +lost pictures from digital camera memory or even Hard Disks. +It has been extended to search also for non audio/video headers. +It searches for + +- Sun/NeXT audio data (.au) +- RIFF audio/video (.avi/.wav) +- BMP bitmap (.bmp) +- bzip2 compressed data (.bz2) +- Source code written in C (.c) +- Canon Raw picture (.crw) +- Canon catalog (.ctg) +- FAT subdirectory +- Microsoft Office Document (.doc) +- Nikon dsc (.dsc) +- HTML page (.html) +- JPEG picture (.jpg) +- MOV video (.mov) +- MP3 audio (MPEG ADTS, layer III, v1) (.mp3) +- Moving Picture Experts Group video (.mpg) +- Minolta Raw picture (.mrw) +- Olympus Raw Format picture (.orf) +- Portable Document Format (.pdf) +- Perl script (.pl) +- Portable Network Graphics (.png) +- Raw Fujifilm picture (.raf) +- Contax picture (.raw) +- Rollei picture (.rdc) +- Rich Text Format (.rtf) +- Shell script (.sh) +- Tar archive (.tar ) +- Tag Image File Format (.tiff) +- Microsoft ASF (.wma) +- Sigma/Foveon X3 raw picture (.x3f) +- zip archive (.zip) + +TestDisk and PhotoRec run under: + +- Dos, Win9x +- Windows +- Linux +- FreeBSD, NetBSD, OpenBSD +- SunOS + +Both are under GNU General Public License. + +Christophe GRENIER +[grenier@cgsecurity.org](mailto:grenier@cgsecurity.org) +[http://www.cgsecurity.org/](http://www.cgsecurity.org/) + +[![Build Status](https://travis-ci.org/cgsecurity/testdisk.svg?branch=master)](https://travis-ci.org/cgsecurity/testdisk) diff --git a/README_dev_photorec.txt b/README_dev_photorec.txt new file mode 100644 index 00000000..04d64e99 --- /dev/null +++ b/README_dev_photorec.txt @@ -0,0 +1,58 @@ +PhotoRec - Theory of operation: + +Carvers are plugable. Each carver consists of: + +struct file_hint_t - describes extension, name, max size, enable by default, etc. +file_enable_t list_file_enable[] - array with all file hints and whether enabled or not. + + +phmain.c - Contains the main() and driver logic for photorec. + +main(): + - reads parameters + - scans for available devices + - parses the HD (or image) + - resets the list of which file carvers are enabled + - Initializes ncurses + - Calls do_curses_photorec() (in pdisksel.c) + - shuts down ncurses + + +pdiskseln.c - + int do_curses_photorec(struct ph_param *params, struct ph_options *options, const list_disk_t *list_disk) + - Implements Disk selection + - May call photorec_disk_selection_ncurses() + - Eventually call menu_photorec() in ppartseln.c + +ppartseln.c - + void menu_photorec(struct ph_param *params, struct ph_options *options, alloc_data_t*list_search_space) + - Implements Partition selection and Search/Options/File Opt/Geometry/Quit menu + - Search Option call photorec() + +phrecn.c - + int photorec(struct ph_param *params, const struct ph_options *options, alloc_data_t *list_search_space) + - runs multiple passes until status==STATUS_QUIT + - calls photorec_mkdir() to actually make the output directory + - calls photorec_find_blocksize() to find the block size + - calls photorec_aux() to do the recovery + - may call photorec_bf() to recover more files by brute-force method + +src/psearchn.c - + pstatus_t photorec_aux(struct ph_param *params, const struct ph_options *options, alloc_data_t *list_search_space) + - calls file_finish2() when recovery of a file is finished (ie. a new file has been found) + - calls file_recovery_aborted() if the user stops the recovery or there is not enough space on the destination + +photorec.c: - + int file_finish_bf(file_recovery_t *file_recovery, struct ph_param *params, alloc_data_t *list_search_space) + - called when recovery of a file is done by + - photorec_bf() + - photorec_bf_pad() + - photorec_bf_frag() + - photorec_bf_aux() + +photorec.c + pfstatus_t file_finish2(file_recovery_t *file_recovery, struct ph_param *params, const int paranoid, alloc_data_t *list_search_space) + - called when a file is done by + - photorec_aux() (in three places) + + diff --git a/configure.ac b/configure.ac index 9388b7e2..89d9a62b 100644 --- a/configure.ac +++ b/configure.ac @@ -13,7 +13,7 @@ AC_CANONICAL_HOST([]) AC_CANONICAL_TARGET([]) AC_CONFIG_SRCDIR([config.h.in]) AC_CONFIG_HEADERS([config.h]) -AM_INIT_AUTOMAKE +AM_INIT_AUTOMAKE([-Wall foreign]) m4_ifdef([AM_SILENT_RULES], [AM_SILENT_RULES([yes])]) AC_DEFINE([_GNU_SOURCE], 1, [Enable GNU extensions])