diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 66 |
1 files changed, 51 insertions, 15 deletions
| @@ -1,34 +1,70 @@ | |||
| 1 | libextractor | 1 | About |
| 2 | ============ | 2 | ===== |
| 3 | |||
| 4 | GNU libextractor is a simple C library for keyword extraction. | ||
| 5 | Common use-cases for GNU libextractor include detail-views in | ||
| 6 | file managers, detailed search results in file-sharing networks | ||
| 7 | and general information gathering in forensics investigations | ||
| 8 | and penetration testing. | ||
| 3 | 9 | ||
| 4 | libextractor is a simple library for keyword extraction. libextractor | 10 | Bindings for GNU libextractor exists for many languages in addition to |
| 5 | does not support all formats but supports a simple plugging mechanism | 11 | the standard C/C++ API (we know about bindings for Java, Perl, PHP, |
| 6 | such that you can quickly add extractors for additional formats, even | 12 | Mono, Python, Ruby). |
| 7 | without recompiling libextractor. libextractor typically ships with a | ||
| 8 | few dozen helper-libraries (plugins) that can be used to obtain | ||
| 9 | keywords from common file-types. | ||
| 10 | 13 | ||
| 11 | libextractor is a GNU package (http://www.gnu.org/). | 14 | libextractor uses a plugin mechanism to enable developers to quickly |
| 15 | add extractors for additional formats. Plugins are executed | ||
| 16 | out-of-process and can thus bugs in them (or the libraries that they | ||
| 17 | use) cannot crash the main application. libextractor typically ships | ||
| 18 | with a few dozen plugins that can be used to obtain keywords from | ||
| 19 | common file types. | ||
| 12 | 20 | ||
| 13 | More detailed documentation is available in the GNU libextractor manual. | 21 | More detailed documentation is available in the GNU libextractor |
| 22 | manual. libextractor is an official GNU package and available from | ||
| 23 | http://www.gnu.org/s/libextractor/. | ||
| 14 | 24 | ||
| 15 | 25 | ||
| 16 | extract | 26 | extract |
| 17 | ======= | 27 | ======= |
| 18 | 28 | ||
| 19 | extract is a simple command-line interface to libextractor. | 29 | extract is a simple command-line interface to GNU libextractor. |
| 20 | |||
| 21 | 30 | ||
| 22 | 31 | ||
| 23 | Dependencies | 32 | Dependencies |
| 24 | ============ | 33 | ============ |
| 25 | 34 | ||
| 26 | * zlib (compression library) | ||
| 27 | * GNU C/C++ compiler | 35 | * GNU C/C++ compiler |
| 28 | * libltdl 2.2.x (from GNU libtool) | 36 | * libltdl 2.2.x (from GNU libtool) |
| 29 | * GNU libtool 2.2 or higher | 37 | * GNU libtool 2.2 or higher |
| 30 | * GNU gettext | 38 | * GNU gettext |
| 31 | 39 | ||
| 40 | The following dependencies are all optional, but should be | ||
| 41 | available in order for maximum coverage: | ||
| 42 | |||
| 43 | * libavutil / libavformat / libavcodec / libswscale (ffmpeg) | ||
| 44 | * libbz2 (bzip2) | ||
| 45 | * libexiv2 | ||
| 46 | * libflac | ||
| 47 | * libgif (giflib) | ||
| 48 | * libglib (glib) | ||
| 49 | * libgtk+ | ||
| 50 | * libgsf | ||
| 51 | * libgstreamer | ||
| 52 | * libjpeg | ||
| 53 | * libmagic (file) | ||
| 54 | * libmpeg2 | ||
| 55 | * librpm | ||
| 56 | * libtidy | ||
| 57 | * libtiff | ||
| 58 | * libvorbis / libogg | ||
| 59 | * libz (zlib) | ||
| 60 | |||
| 32 | When building libextractor binaries, please make sure all of these | 61 | When building libextractor binaries, please make sure all of these |
| 33 | dependencies are available. Otherwise the build system may | 62 | dependencies are available and configure detects a sufficiently recent |
| 34 | automatically build only a subset of libextractor. | 63 | installation. Otherwise the build system may automatically build only |
| 64 | a subset of GNU libextractor resulting in mediocre meta data | ||
| 65 | production. | ||
| 66 | |||
| 67 | Finally, 'zzuf' is a fuzzing tool that can optionally be detected by | ||
| 68 | the build system and be used for debugging / testing. It is not required | ||
| 69 | at runtime or for normal builds. | ||
| 70 | |||