summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 15 insertions, 8 deletions
diff --git a/README.md b/README.md
index 5d25b71..f125d45 100644
--- a/README.md
+++ b/README.md
@@ -44,20 +44,27 @@ $ python3 -m unittest discover -v
44# How to use MAT2 44# How to use MAT2
45 45
46```bash 46```bash
47usage: mat2 [-h] [-v] [-l] [-s | -L] [files [files ...]] 47usage: mat2 [-h] [-v] [-l] [--check-dependencies] [-V]
48 [--unknown-members policy] [-s | -L]
49 [files [files ...]]
48 50
49Metadata anonymisation toolkit 2 51Metadata anonymisation toolkit 2
50 52
51positional arguments: 53positional arguments:
52 files 54 files the files to process
53 55
54optional arguments: 56optional arguments:
55 -h, --help show this help message and exit 57 -h, --help show this help message and exit
56 -v, --version show program's version number and exit 58 -v, --version show program's version number and exit
57 -l, --list list all supported fileformats 59 -l, --list list all supported fileformats
58 -s, --show list all the harmful metadata of a file without removing 60 --check-dependencies check if MAT2 has all the dependencies it needs
59 them 61 -V, --verbose show more verbose status information
60 -L, --lightweight remove SOME metadata 62 --unknown-members policy
63 how to handle unknown members of archive-style files
64 (policy should be one of: abort, omit, keep)
65 -s, --show list harmful metadata detectable by MAT2 without
66 removing them
67 -L, --lightweight remove SOME metadata
61``` 68```
62 69
63Note that MAT2 **will not** clean files in-place, but will produce, for 70Note that MAT2 **will not** clean files in-place, but will produce, for