diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 15 |
1 files changed, 12 insertions, 3 deletions
| @@ -44,7 +44,7 @@ $ python3 -m unittest discover -v | |||
| 44 | # How to use MAT2 | 44 | # How to use MAT2 |
| 45 | 45 | ||
| 46 | ```bash | 46 | ```bash |
| 47 | usage: mat2 [-h] [-v] [-l] [-c | -s | -L] [files [files ...]] | 47 | usage: mat2 [-h] [-v] [-l] [-s | -L] [files [files ...]] |
| 48 | 48 | ||
| 49 | Metadata anonymisation toolkit 2 | 49 | Metadata anonymisation toolkit 2 |
| 50 | 50 | ||
| @@ -55,15 +55,24 @@ optional arguments: | |||
| 55 | -h, --help show this help message and exit | 55 | -h, --help show this help message and exit |
| 56 | -v, --version show program's version number and exit | 56 | -v, --version show program's version number and exit |
| 57 | -l, --list list all supported fileformats | 57 | -l, --list list all supported fileformats |
| 58 | -c, --check check if a file is free of harmful metadatas | ||
| 59 | -s, --show list all the harmful metadata of a file without removing | 58 | -s, --show list all the harmful metadata of a file without removing |
| 60 | them | 59 | them |
| 61 | -L, --lightweight remove SOME metadata | 60 | -L, --lightweight remove SOME metadata |
| 62 | ``` | 61 | ``` |
| 63 | 62 | ||
| 63 | # Notes about detecting metadata | ||
| 64 | |||
| 65 | While MAT2 is doing its very best to display metadata when the `--show` flag is | ||
| 66 | passed, it doesn't mean that a file is clean from any metadata if MAT2 doesn't | ||
| 67 | show any. There is no reliable way to detect every single possible metadata for | ||
| 68 | complex file formats. | ||
| 69 | |||
| 70 | This is why you shouldn't rely on metadata's presence to decide if your file must | ||
| 71 | be cleaned or not. | ||
| 72 | |||
| 64 | # Related software | 73 | # Related software |
| 65 | 74 | ||
| 66 | - The first iteration of [MAT](http://mat.boum.org) | 75 | - The first iteration of [MAT](https://mat.boum.org) |
| 67 | - [Exiftool](https://sno.phy.queensu.ca/~phil/exiftool/mat) | 76 | - [Exiftool](https://sno.phy.queensu.ca/~phil/exiftool/mat) |
| 68 | - [pdf-redact-tools](https://github.com/firstlookmedia/pdf-redact-tools), that | 77 | - [pdf-redact-tools](https://github.com/firstlookmedia/pdf-redact-tools), that |
| 69 | tries to deal with *printer dots* too. | 78 | tries to deal with *printer dots* too. |
