summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorgeorg2019-11-28 02:15:20 +0000
committerjvoisin2019-11-30 01:14:41 -0800
commit697cb36b814d7e01da336c43b1932264302a2528 (patch)
treec14075024469adf5aa30614c95173cada156229c /README.md
parent6e52661cfb4e79a76a6ff80637d5adf495a15479 (diff)
This is mat2, not MAT2
Closes #131
Diffstat (limited to '')
-rw-r--r--README.md22
1 files changed, 11 insertions, 11 deletions
diff --git a/README.md b/README.md
index 33d0296..e0866b4 100644
--- a/README.md
+++ b/README.md
@@ -22,10 +22,10 @@ camera was used. Office documents like PDF or Office automatically adds
22author and company information to documents and spreadsheets. 22author and company information to documents and spreadsheets.
23Maybe you don't want to disclose those information. 23Maybe you don't want to disclose those information.
24 24
25This is precisely the job of MAT2: getting rid, as much as possible, of 25This is precisely the job of mat2: getting rid, as much as possible, of
26metadata. 26metadata.
27 27
28MAT2 provides both a command line tool, and a graphical user interface 28mat2 provides both a command line tool, and a graphical user interface
29via an extension for Nautilus, the default file manager of GNOME. 29via an extension for Nautilus, the default file manager of GNOME.
30 30
31# Requirements 31# Requirements
@@ -38,7 +38,7 @@ via an extension for Nautilus, the default file manager of GNOME.
38- `libimage-exiftool-perl` for everything else 38- `libimage-exiftool-perl` for everything else
39- `bubblewrap`, optionally, for sandboxing 39- `bubblewrap`, optionally, for sandboxing
40 40
41Please note that MAT2 requires at least Python3.5. 41Please note that mat2 requires at least Python3.5.
42 42
43# Running the test suite 43# Running the test suite
44 44
@@ -53,7 +53,7 @@ $ python3-coverage run --branch -m unittest discover -s tests/
53$ python3-coverage report --include -m --include /libmat2/*' 53$ python3-coverage report --include -m --include /libmat2/*'
54``` 54```
55 55
56# How to use MAT2 56# How to use mat2
57 57
58```bash 58```bash
59usage: mat2 [-h] [-v] [-l] [--check-dependencies] [-V] 59usage: mat2 [-h] [-v] [-l] [--check-dependencies] [-V]
@@ -69,25 +69,25 @@ optional arguments:
69 -h, --help show this help message and exit 69 -h, --help show this help message and exit
70 -v, --version show program's version number and exit 70 -v, --version show program's version number and exit
71 -l, --list list all supported fileformats 71 -l, --list list all supported fileformats
72 --check-dependencies check if MAT2 has all the dependencies it needs 72 --check-dependencies check if mat2 has all the dependencies it needs
73 -V, --verbose show more verbose status information 73 -V, --verbose show more verbose status information
74 --unknown-members policy 74 --unknown-members policy
75 how to handle unknown members of archive-style files 75 how to handle unknown members of archive-style files
76 (policy should be one of: abort, omit, keep) [Default: 76 (policy should be one of: abort, omit, keep) [Default:
77 abort] 77 abort]
78 -s, --show list harmful metadata detectable by MAT2 without 78 -s, --show list harmful metadata detectable by mat2 without
79 removing them 79 removing them
80 -L, --lightweight remove SOME metadata 80 -L, --lightweight remove SOME metadata
81``` 81```
82 82
83Note that MAT2 **will not** clean files in-place, but will produce, for 83Note that mat2 **will not** clean files in-place, but will produce, for
84example, with a file named "myfile.png" a cleaned version named 84example, with a file named "myfile.png" a cleaned version named
85"myfile.cleaned.png". 85"myfile.cleaned.png".
86 86
87# Notes about detecting metadata 87# Notes about detecting metadata
88 88
89While MAT2 is doing its very best to display metadata when the `--show` flag is 89While mat2 is doing its very best to display metadata when the `--show` flag is
90passed, it doesn't mean that a file is clean from any metadata if MAT2 doesn't 90passed, it doesn't mean that a file is clean from any metadata if mat2 doesn't
91show any. There is no reliable way to detect every single possible metadata for 91show any. There is no reliable way to detect every single possible metadata for
92complex file formats. 92complex file formats.
93 93
@@ -138,14 +138,14 @@ You should have received a copy of the GNU Lesser General Public License
138along with this program. If not, see <http://www.gnu.org/licenses/>. 138along with this program. If not, see <http://www.gnu.org/licenses/>.
139 139
140Copyright 2018 Julien (jvoisin) Voisin <julien.voisin+mat2@dustri.org> 140Copyright 2018 Julien (jvoisin) Voisin <julien.voisin+mat2@dustri.org>
141Copyright 2016 Marie-Rose for MAT2's logo 141Copyright 2016 Marie-Rose for mat2's logo
142 142
143The `tests/data/dirty_with_nsid.docx` file is licensed under GPLv3, 143The `tests/data/dirty_with_nsid.docx` file is licensed under GPLv3,
144and was borrowed from the Calibre project: https://calibre-ebook.com/downloads/demos/demo.docx 144and was borrowed from the Calibre project: https://calibre-ebook.com/downloads/demos/demo.docx
145 145
146# Thanks 146# Thanks
147 147
148MAT2 wouldn't exist without: 148mat2 wouldn't exist without:
149 149
150- the [Google Summer of Code](https://summerofcode.withgoogle.com/); 150- the [Google Summer of Code](https://summerofcode.withgoogle.com/);
151- the fine people from [Tails]( https://tails.boum.org); 151- the fine people from [Tails]( https://tails.boum.org);