1
0
mirror of synced 2024-11-22 01:04:23 +01:00

Update the help section of the readme

This commit is contained in:
jvoisin 2019-12-08 11:28:32 +01:00
parent 4ba4b143e6
commit 615997be38

View File

@ -56,9 +56,9 @@ $ python3-coverage report --include -m --include /libmat2/*'
# How to use mat2 # How to use mat2
```bash ```
usage: mat2 [-h] [-v] [-l] [--check-dependencies] [-V] usage: mat2 [-h] [-V] [--unknown-members policy] [--inplace] [--no-sandbox]
[--unknown-members policy] [-s | -L] [-v] [-l] [--check-dependencies] [-L | -s]
[files [files ...]] [files [files ...]]
Metadata anonymisation toolkit 2 Metadata anonymisation toolkit 2
@ -68,17 +68,19 @@ positional arguments:
optional arguments: optional arguments:
-h, --help show this help message and exit -h, --help show this help message and exit
-v, --version show program's version number and exit
-l, --list list all supported fileformats
--check-dependencies check if mat2 has all the dependencies it needs
-V, --verbose show more verbose status information -V, --verbose show more verbose status information
--unknown-members policy --unknown-members policy
how to handle unknown members of archive-style files how to handle unknown members of archive-style files
(policy should be one of: abort, omit, keep) [Default: (policy should be one of: abort, omit, keep) [Default:
abort] abort]
--inplace clean in place, without backup
--no-sandbox Disable bubblewrap's sandboxing.
-v, --version show program's version number and exit
-l, --list list all supported fileformats
--check-dependencies check if mat2 has all the dependencies it needs
-L, --lightweight remove SOME metadata
-s, --show list harmful metadata detectable by mat2 without -s, --show list harmful metadata detectable by mat2 without
removing them removing them
-L, --lightweight remove SOME metadata
``` ```
Note that mat2 **will not** clean files in-place, but will produce, for Note that mat2 **will not** clean files in-place, but will produce, for