summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorjvoisin2019-12-08 11:28:32 +0100
committerjvoisin2019-12-08 11:28:32 +0100
commit615997be38f47af83c1d33c9fb56185c3710ca57 (patch)
tree8d3daa53d435fd4cd8b17bff9d019b42f0204305 /README.md
parent4ba4b143e6bdbb9a73e279368a8b66931a1090b1 (diff)
Update the help section of the readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 9 insertions, 7 deletions
diff --git a/README.md b/README.md
index affbf62..2aeb493 100644
--- a/README.md
+++ b/README.md
@@ -56,9 +56,9 @@ $ python3-coverage report --include -m --include /libmat2/*'
56 56
57# How to use mat2 57# How to use mat2
58 58
59```bash 59```
60usage: mat2 [-h] [-v] [-l] [--check-dependencies] [-V] 60usage: mat2 [-h] [-V] [--unknown-members policy] [--inplace] [--no-sandbox]
61 [--unknown-members policy] [-s | -L] 61 [-v] [-l] [--check-dependencies] [-L | -s]
62 [files [files ...]] 62 [files [files ...]]
63 63
64Metadata anonymisation toolkit 2 64Metadata anonymisation toolkit 2
@@ -68,17 +68,19 @@ positional arguments:
68 68
69optional arguments: 69optional arguments:
70 -h, --help show this help message and exit 70 -h, --help show this help message and exit
71 -v, --version show program's version number and exit
72 -l, --list list all supported fileformats
73 --check-dependencies check if mat2 has all the dependencies it needs
74 -V, --verbose show more verbose status information 71 -V, --verbose show more verbose status information
75 --unknown-members policy 72 --unknown-members policy
76 how to handle unknown members of archive-style files 73 how to handle unknown members of archive-style files
77 (policy should be one of: abort, omit, keep) [Default: 74 (policy should be one of: abort, omit, keep) [Default:
78 abort] 75 abort]
76 --inplace clean in place, without backup
77 --no-sandbox Disable bubblewrap's sandboxing.
78 -v, --version show program's version number and exit
79 -l, --list list all supported fileformats
80 --check-dependencies check if mat2 has all the dependencies it needs
81 -L, --lightweight remove SOME metadata
79 -s, --show list harmful metadata detectable by mat2 without 82 -s, --show list harmful metadata detectable by mat2 without
80 removing them 83 removing them
81 -L, --lightweight remove SOME metadata
82``` 84```
83 85
84Note that mat2 **will not** clean files in-place, but will produce, for 86Note that mat2 **will not** clean files in-place, but will produce, for