diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/mat.1 | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/doc/mat.1 b/doc/mat.1 new file mode 100644 index 0000000..a69bf7c --- /dev/null +++ b/doc/mat.1 | |||
| @@ -0,0 +1,66 @@ | |||
| 1 | .TH MAT2 "1" "July 2018" "MAT2 0.2.0" "User Commands" | ||
| 2 | |||
| 3 | .SH NAME | ||
| 4 | mat2 \- the metadata anonymisation toolkit 2 | ||
| 5 | |||
| 6 | .SH SYNOPSIS | ||
| 7 | mat2 [\-h] [\-v] [\-l] [\-c] [\-s | \-L]\fR [files [files ...]] | ||
| 8 | |||
| 9 | .SH DESCRIPTION | ||
| 10 | .B mat2 | ||
| 11 | removes metadata from various fileformats. It supports a wide variety of file | ||
| 12 | formats, audio, office, images, … | ||
| 13 | |||
| 14 | .SH OPTIONS | ||
| 15 | .SS "positional arguments:" | ||
| 16 | .TP | ||
| 17 | \fBfiles\fR | ||
| 18 | the files to process | ||
| 19 | .SS "optional arguments:" | ||
| 20 | .TP | ||
| 21 | \fB\-h\fR, \fB\-\-help\fR | ||
| 22 | show this help message and exit | ||
| 23 | .TP | ||
| 24 | \fB\-v\fR, \fB\-\-version\fR | ||
| 25 | show program's version number and exit | ||
| 26 | .TP | ||
| 27 | \fB\-l\fR, \fB\-\-list\fR | ||
| 28 | list all supported fileformats | ||
| 29 | .TP | ||
| 30 | \fB\-c\fR, \fB\-\-check\-dependencies\fR | ||
| 31 | check if MAT2 has all the dependencies it needs | ||
| 32 | .TP | ||
| 33 | \fB\-s\fR, \fB\-\-show\fR | ||
| 34 | list harmful metadata detectable by MAT2 without | ||
| 35 | removing them | ||
| 36 | .TP | ||
| 37 | \fB\-L\fR, \fB\-\-lightweight\fR | ||
| 38 | remove SOME metadata | ||
| 39 | |||
| 40 | .SH EXAMPLES | ||
| 41 | To remove all the metadata from a PDF file: | ||
| 42 | .PP | ||
| 43 | .nf | ||
| 44 | .RS | ||
| 45 | mat2 ./myfile.pdf | ||
| 46 | .RE | ||
| 47 | .fi | ||
| 48 | .PP | ||
| 49 | |||
| 50 | .SH BUGS | ||
| 51 | |||
| 52 | While mat2 does its very best to remove every single metadata, | ||
| 53 | it's still in beta, and \fBsome\fR might remain. Should you encounter | ||
| 54 | some issues, check the bugtracker: https://0xacab.org/jvoisin/mat2/issues | ||
| 55 | .PP | ||
| 56 | Please use accordingly and be careful. | ||
| 57 | |||
| 58 | .SH AUTHOR | ||
| 59 | This software was made by Julien (jvoisin) Voisin with the support of the Tails project. | ||
| 60 | |||
| 61 | .SH COPYRIGHT | ||
| 62 | This software is released on LGPLv3. | ||
| 63 | |||
| 64 | .SH "SEE ALSO" | ||
| 65 | .BR exiftool (1p) | ||
| 66 | .BR pdf-redact-tools (1) | ||
