2023-02-23 21:36:46 +01:00
|
|
|
.TH mat2 "1" "February 2023" "mat2 0.13.3" "User Commands"
|
2018-07-24 22:34:33 +02:00
|
|
|
|
|
|
|
|
.SH NAME
|
|
|
|
|
mat2 \- the metadata anonymisation toolkit 2
|
|
|
|
|
|
|
|
|
|
.SH SYNOPSIS
|
2018-10-03 16:12:03 +02:00
|
|
|
\fBmat2\fR [\-h] [\-v] [\-l] [\-V] [-s | -L] [\fIfiles\fR [\fIfiles ...\fR]]
|
2018-07-24 22:34:33 +02:00
|
|
|
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
.B mat2
|
2019-03-26 18:10:46 +01:00
|
|
|
removes metadata from various fileformats. It supports a wide variety of file
|
2018-07-24 22:34:33 +02:00
|
|
|
formats, audio, office, images, …
|
|
|
|
|
|
2018-09-26 00:13:44 +02:00
|
|
|
Careful, mat2 does not clean files in-place, instead, it will produce a file with the word
|
|
|
|
|
"cleaned" between the filename and its extension, for example "filename.cleaned.png"
|
|
|
|
|
for a file named "filename.png".
|
|
|
|
|
|
2018-07-24 22:34:33 +02:00
|
|
|
.SH OPTIONS
|
|
|
|
|
.SS "positional arguments:"
|
|
|
|
|
.TP
|
|
|
|
|
\fBfiles\fR
|
|
|
|
|
the files to process
|
|
|
|
|
.SS "optional arguments:"
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-h\fR, \fB\-\-help\fR
|
|
|
|
|
show this help message and exit
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-v\fR, \fB\-\-version\fR
|
|
|
|
|
show program's version number and exit
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-l\fR, \fB\-\-list\fR
|
|
|
|
|
list all supported fileformats
|
|
|
|
|
.TP
|
2018-10-03 16:12:03 +02:00
|
|
|
\fB\-\-check\-dependencies\fR
|
2019-11-28 03:15:20 +01:00
|
|
|
check if mat2 has all the dependencies it needs
|
2018-07-24 22:34:33 +02:00
|
|
|
.TP
|
2018-10-03 16:12:03 +02:00
|
|
|
\fB\-V\fR, \fB\-\-verbose\fR
|
|
|
|
|
show more verbose status information
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-\-unknown-members\fR \fIpolicy\fR
|
|
|
|
|
how to handle unknown members of archive-style files (policy should be one of: abort, omit, keep)
|
|
|
|
|
.TP
|
2018-07-24 22:34:33 +02:00
|
|
|
\fB\-s\fR, \fB\-\-show\fR
|
2019-11-30 18:31:07 +01:00
|
|
|
list harmful metadata detectable by mat2 without removing them
|
2018-07-24 22:34:33 +02:00
|
|
|
.TP
|
|
|
|
|
\fB\-L\fR, \fB\-\-lightweight\fR
|
|
|
|
|
remove SOME metadata
|
2019-11-30 18:31:07 +01:00
|
|
|
.TP
|
|
|
|
|
\fB\--no-sandbox\fR
|
|
|
|
|
disable bubblewrap's sandboxing
|
|
|
|
|
.TP
|
|
|
|
|
\fB\--inplace\fR
|
|
|
|
|
clean in place, without backup
|
2018-07-24 22:34:33 +02:00
|
|
|
|
|
|
|
|
.SH EXAMPLES
|
|
|
|
|
To remove all the metadata from a PDF file:
|
|
|
|
|
.PP
|
|
|
|
|
.nf
|
|
|
|
|
.RS
|
|
|
|
|
mat2 ./myfile.pdf
|
|
|
|
|
.RE
|
|
|
|
|
.fi
|
|
|
|
|
.PP
|
|
|
|
|
|
2019-12-02 17:10:34 +01:00
|
|
|
.SH NOTES ABOUT METADATA
|
|
|
|
|
|
|
|
|
|
While mat2 is doing its very best to display metadata when the --show flag is
|
|
|
|
|
passed, it doesn't mean that a file is clean from any metadata if mat2 doesn't
|
|
|
|
|
show any. There is no reliable way to detect every single possible metadata for
|
|
|
|
|
complex file formats.
|
|
|
|
|
.PP
|
|
|
|
|
This is why you shouldn't rely on metadata's presence to decide if your file must
|
|
|
|
|
be cleaned or not.
|
2020-01-05 20:32:38 +01:00
|
|
|
.PP
|
|
|
|
|
Moreover, mat2 goes to great lengths to make sure that as much metadata as
|
2020-01-06 12:22:10 +01:00
|
|
|
possible are removed. This might sometimes result in a loss of quality of the
|
2020-02-08 17:04:53 +01:00
|
|
|
processed files. For example, textual based pdf file converted into image based
|
|
|
|
|
one means that it'll be no longer possible to select text in them. If you're
|
|
|
|
|
experiencing this, you might want to give the lightweight cleaning mode a try,
|
2020-02-08 14:01:13 +01:00
|
|
|
but keep in mind by doing so, some metadata \fBwon't be cleaned\fR.
|
2020-01-05 20:32:38 +01:00
|
|
|
|
2019-12-02 17:10:34 +01:00
|
|
|
|
2018-07-24 22:34:33 +02:00
|
|
|
.SH BUGS
|
|
|
|
|
|
|
|
|
|
While mat2 does its very best to remove every single metadata,
|
|
|
|
|
it's still in beta, and \fBsome\fR might remain. Should you encounter
|
|
|
|
|
some issues, check the bugtracker: https://0xacab.org/jvoisin/mat2/issues
|
|
|
|
|
.PP
|
|
|
|
|
Please use accordingly and be careful.
|
|
|
|
|
|
|
|
|
|
.SH AUTHOR
|
|
|
|
|
This software was made by Julien (jvoisin) Voisin with the support of the Tails project.
|
|
|
|
|
|
|
|
|
|
.SH COPYRIGHT
|
|
|
|
|
This software is released on LGPLv3.
|
|
|
|
|
|
|
|
|
|
.SH "SEE ALSO"
|
|
|
|
|
.BR exiftool (1p)
|
|
|
|
|
.BR pdf-redact-tools (1)
|
