summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--CONTRIBUTING.md9
-rw-r--r--doc/mat.166
-rwxr-xr-xmat22
3 files changed, 73 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 69f7f6f..fbda04e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -24,6 +24,9 @@ Since MAT2 is written in Python3, please conform as much as possible to the
241. Update the [changelog](https://0xacab.org/jvoisin/mat2/blob/master/CHANGELOG.md) 241. Update the [changelog](https://0xacab.org/jvoisin/mat2/blob/master/CHANGELOG.md)
252. Update the version in the [mat2](https://0xacab.org/jvoisin/mat2/blob/master/mat2) file 252. Update the version in the [mat2](https://0xacab.org/jvoisin/mat2/blob/master/mat2) file
263. Update the version in the [setup.py](https://0xacab.org/jvoisin/mat2/blob/master/setup.py) file 263. Update the version in the [setup.py](https://0xacab.org/jvoisin/mat2/blob/master/setup.py) file
274. Commit the changelog, mat2 and setup.py files 274. Update the version and date in the [man page](https://0xacab.org/jvoisin/mat2/blob/master/doc/mat.1)
285. Create a tag with `git tag -s $VERSION` 285. Commit the changelog, man page, mat2 and setup.py files
296. Push the tag with `git push --tags` 296. Create a tag with `git tag -s $VERSION`
307. Push the commit with `git push origin master`
318. Push the tag with `git push --tags`
329. Do the secret release dance
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
4mat2 \- the metadata anonymisation toolkit 2
5
6.SH SYNOPSIS
7mat2 [\-h] [\-v] [\-l] [\-c] [\-s | \-L]\fR [files [files ...]]
8
9.SH DESCRIPTION
10.B mat2
11removes metadata from various fileformats. It supports a wide variety of file
12formats, audio, office, images, …
13
14.SH OPTIONS
15.SS "positional arguments:"
16.TP
17\fBfiles\fR
18the files to process
19.SS "optional arguments:"
20.TP
21\fB\-h\fR, \fB\-\-help\fR
22show this help message and exit
23.TP
24\fB\-v\fR, \fB\-\-version\fR
25show program's version number and exit
26.TP
27\fB\-l\fR, \fB\-\-list\fR
28list all supported fileformats
29.TP
30\fB\-c\fR, \fB\-\-check\-dependencies\fR
31check if MAT2 has all the dependencies it needs
32.TP
33\fB\-s\fR, \fB\-\-show\fR
34list harmful metadata detectable by MAT2 without
35removing them
36.TP
37\fB\-L\fR, \fB\-\-lightweight\fR
38remove SOME metadata
39
40.SH EXAMPLES
41To remove all the metadata from a PDF file:
42.PP
43.nf
44.RS
45mat2 ./myfile.pdf
46.RE
47.fi
48.PP
49
50.SH BUGS
51
52While mat2 does its very best to remove every single metadata,
53it's still in beta, and \fBsome\fR might remain. Should you encounter
54some issues, check the bugtracker: https://0xacab.org/jvoisin/mat2/issues
55.PP
56Please use accordingly and be careful.
57
58.SH AUTHOR
59This software was made by Julien (jvoisin) Voisin with the support of the Tails project.
60
61.SH COPYRIGHT
62This software is released on LGPLv3.
63
64.SH "SEE ALSO"
65.BR exiftool (1p)
66.BR pdf-redact-tools (1)
diff --git a/mat2 b/mat2
index 5942d84..d24f2bc 100755
--- a/mat2
+++ b/mat2
@@ -31,7 +31,7 @@ def __check_file(filename: str, mode: int=os.R_OK) -> bool:
31 31
32def create_arg_parser(): 32def create_arg_parser():
33 parser = argparse.ArgumentParser(description='Metadata anonymisation toolkit 2') 33 parser = argparse.ArgumentParser(description='Metadata anonymisation toolkit 2')
34 parser.add_argument('files', nargs='*') 34 parser.add_argument('files', nargs='*', help='the files to process')
35 parser.add_argument('-v', '--version', action='version', 35 parser.add_argument('-v', '--version', action='version',
36 version='MAT2 %s' % __version__) 36 version='MAT2 %s' % __version__)
37 parser.add_argument('-l', '--list', action='store_true', 37 parser.add_argument('-l', '--list', action='store_true',