Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
mat2
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
tails
mat2
Commits
e9f28edf
Commit
e9f28edf
authored
6 years ago
by
Julien (jvoisin) Voisin
Browse files
Options
Downloads
Patches
Plain Diff
Add a man page and document how to keep it up to date
parent
7697f9c0
No related branches found
No related tags found
No related merge requests found
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
CONTRIBUTING.md
+6
-3
6 additions, 3 deletions
CONTRIBUTING.md
doc/mat.1
+66
-0
66 additions, 0 deletions
doc/mat.1
mat2
+1
-1
1 addition, 1 deletion
mat2
with
73 additions
and
4 deletions
CONTRIBUTING.md
+
6
−
3
View file @
e9f28edf
...
@@ -24,6 +24,9 @@ Since MAT2 is written in Python3, please conform as much as possible to the
...
@@ -24,6 +24,9 @@ Since MAT2 is written in Python3, please conform as much as possible to the
1.
Update the
[
changelog
](
https://0xacab.org/jvoisin/mat2/blob/master/CHANGELOG.md
)
1.
Update the
[
changelog
](
https://0xacab.org/jvoisin/mat2/blob/master/CHANGELOG.md
)
2.
Update the version in the
[
mat2
](
https://0xacab.org/jvoisin/mat2/blob/master/mat2
)
file
2.
Update the version in the
[
mat2
](
https://0xacab.org/jvoisin/mat2/blob/master/mat2
)
file
3.
Update the version in the
[
setup.py
](
https://0xacab.org/jvoisin/mat2/blob/master/setup.py
)
file
3.
Update the version in the
[
setup.py
](
https://0xacab.org/jvoisin/mat2/blob/master/setup.py
)
file
4.
Commit the changelog, mat2 and setup.py files
4.
Update the version and date in the
[
man page
](
https://0xacab.org/jvoisin/mat2/blob/master/doc/mat.1
)
5.
Create a tag with
`git tag -s $VERSION`
5.
Commit the changelog, man page, mat2 and setup.py files
6.
Push the tag with
`git push --tags`
6.
Create a tag with
`git tag -s $VERSION`
7.
Push the commit with
`git push origin master`
8.
Push the tag with
`git push --tags`
9.
Do the secret release dance
This diff is collapsed.
Click to expand it.
doc/mat.1
0 → 100644
+
66
−
0
View file @
e9f28edf
.TH MAT2 "1" "July 2018" "MAT2 0.2.0" "User Commands"
.SH NAME
mat2 \- the metadata anonymisation toolkit 2
.SH SYNOPSIS
mat2 [\-h] [\-v] [\-l] [\-c] [\-s | \-L]\fR [files [files ...]]
.SH DESCRIPTION
.B mat2
removes metadata from various fileformats. It supports a wide variety of file
formats, audio, office, images, …
.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
\fB\-c\fR, \fB\-\-check\-dependencies\fR
check if MAT2 has all the dependencies it needs
.TP
\fB\-s\fR, \fB\-\-show\fR
list harmful metadata detectable by MAT2 without
removing them
.TP
\fB\-L\fR, \fB\-\-lightweight\fR
remove SOME metadata
.SH EXAMPLES
To remove all the metadata from a PDF file:
.PP
.nf
.RS
mat2 ./myfile.pdf
.RE
.fi
.PP
.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)
This diff is collapsed.
Click to expand it.
mat2
+
1
−
1
View file @
e9f28edf
...
@@ -31,7 +31,7 @@ def __check_file(filename: str, mode: int=os.R_OK) -> bool:
...
@@ -31,7 +31,7 @@ def __check_file(filename: str, mode: int=os.R_OK) -> bool:
def
create_arg_parser
():
def
create_arg_parser
():
parser
=
argparse
.
ArgumentParser
(
description
=
'
Metadata anonymisation toolkit 2
'
)
parser
=
argparse
.
ArgumentParser
(
description
=
'
Metadata anonymisation toolkit 2
'
)
parser
.
add_argument
(
'
files
'
,
nargs
=
'
*
'
)
parser
.
add_argument
(
'
files
'
,
nargs
=
'
*
'
,
help
=
'
the files to process
'
)
parser
.
add_argument
(
'
-v
'
,
'
--version
'
,
action
=
'
version
'
,
parser
.
add_argument
(
'
-v
'
,
'
--version
'
,
action
=
'
version
'
,
version
=
'
MAT2 %s
'
%
__version__
)
version
=
'
MAT2 %s
'
%
__version__
)
parser
.
add_argument
(
'
-l
'
,
'
--list
'
,
action
=
'
store_true
'
,
parser
.
add_argument
(
'
-l
'
,
'
--list
'
,
action
=
'
store_true
'
,
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment