diff options
| author | jvoisin | 2015-11-25 13:47:54 +0100 |
|---|---|---|
| committer | jvoisin | 2015-11-26 15:47:30 +0100 |
| commit | a71bbcaf57be3076cb7bd38d07cf13e71fcbe611 (patch) | |
| tree | 47d41286373acb2f7c351ade8bb26fd635d29c8e /README | |
| parent | 4de7342a67e3cf08dabf616e6bbf0bbbae2f507f (diff) | |
The README file now has a `.md` extension.
Diffstat (limited to 'README')
| -rw-r--r-- | README | 101 |
1 files changed, 0 insertions, 101 deletions
| @@ -1,101 +0,0 @@ | |||
| 1 | METADATA | ||
| 2 | ======== | ||
| 3 | Metadata consist of information that characterizes data. | ||
| 4 | Metadata are used to provide documentation for data products. | ||
| 5 | In essence, metadata answer who, what, when, where, why, and how about | ||
| 6 | every facet of the data that are being documented. | ||
| 7 | |||
| 8 | METADATA AND PRIVACY | ||
| 9 | ==================== | ||
| 10 | Metadata within a file can tell a lot about you. | ||
| 11 | Cameras record data about when a picture was taken and what | ||
| 12 | camera was used. Office documents like PDF or Office automatically adds | ||
| 13 | author and company information to documents and spreadsheets. | ||
| 14 | Maybe you don't want to disclose those information on the web. | ||
| 15 | |||
| 16 | WARNINGS | ||
| 17 | ======== | ||
| 18 | See README.security | ||
| 19 | |||
| 20 | DEPENDENCIES | ||
| 21 | ============ | ||
| 22 | * python2.7 (at least) | ||
| 23 | * python-hachoir-core and python-hachoir-parser | ||
| 24 | * python-pil for more secure images handling | ||
| 25 | * python-pdfrw, gir-poppler and python-gi-cairo for full PDF support | ||
| 26 | * python-gi for the GUI | ||
| 27 | * shred (should be already installed) | ||
| 28 | |||
| 29 | OPTIONALS DEPENDENCIES | ||
| 30 | ====================== | ||
| 31 | * python-mutagen: for massive audio format support | ||
| 32 | * exiftool: for _massive_ image format support | ||
| 33 | |||
| 34 | USAGE | ||
| 35 | ===== | ||
| 36 | mat --help | ||
| 37 | or | ||
| 38 | |||
| 39 | mat-gui | ||
| 40 | |||
| 41 | SUPPORTED FORMAT | ||
| 42 | ================ | ||
| 43 | See ./data/FORMATS | ||
| 44 | |||
| 45 | HOW TO IMPLEMENT NEW FORMATS | ||
| 46 | ============================ | ||
| 47 | 1. Add the format's mimetype to the STRIPPER list in strippers.py | ||
| 48 | 2. Inherit the GenericParser class (parser.py) | ||
| 49 | 3. Read the parser.py module | ||
| 50 | 4. Implement at least these three methods: | ||
| 51 | - is_clean(self) | ||
| 52 | - remove_all(self) | ||
| 53 | - get_meta(self) | ||
| 54 | 5. Don't forget to call the do_backup() method when necessary | ||
| 55 | |||
| 56 | HOW TO LAUNCH THE TESTSUITE | ||
| 57 | =========================== | ||
| 58 | cd ./test | ||
| 59 | python test.py | ||
| 60 | |||
| 61 | LINKS | ||
| 62 | ===== | ||
| 63 | * Official website: https://mat.boum.org | ||
| 64 | * Bugtracker: https://labs.riseup.net/code/projects/mat | ||
| 65 | * Git repo: https://gitweb.torproject.org/user/jvoisin/mat.git | ||
| 66 | |||
| 67 | CONTACT | ||
| 68 | ======= | ||
| 69 | If you have question, patches, bug reports, or simply want to talk about this project, | ||
| 70 | please use the mailing list (https://mailman.boum.org/listinfo/mat-dev). | ||
| 71 | You can also contact contact jvoisin | ||
| 72 | on irc.oftc.net or at julien.voisin@dustri.org. | ||
| 73 | |||
| 74 | LICENSE | ||
| 75 | ======= | ||
| 76 | This program is free software; you can redistribute it and/or modify | ||
| 77 | it under the terms of the GNU General Public License version 2 as | ||
| 78 | published by the Free Software Foundation. | ||
| 79 | |||
| 80 | This program is distributed in the hope that it will be useful, | ||
| 81 | but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| 82 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| 83 | GNU General Public License for more details. | ||
| 84 | |||
| 85 | You should have received a copy of the GNU General Public License | ||
| 86 | along with this program; if not, write to the Free Software | ||
| 87 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, | ||
| 88 | MA 02110-1301, USA. | ||
| 89 | |||
| 90 | Copyright 2011-2015 Julien (jvoisin) Voisin <julien.voisin@dustri.org> | ||
| 91 | |||
| 92 | |||
| 93 | THANKS | ||
| 94 | ====== | ||
| 95 | Mat would not exist without : | ||
| 96 | |||
| 97 | * the Google Summer of Code, | ||
| 98 | * the hachoir library, | ||
| 99 | * people on #tails@oftc | ||
| 100 | |||
| 101 | Many thanks to them ! | ||
