Skip to content

Commit

Permalink
Update manpage
Browse files Browse the repository at this point in the history
  • Loading branch information
hakavlad committed Feb 17, 2024
1 parent e596ada commit d33004c
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 8 deletions.
27 changes: 22 additions & 5 deletions docs/MANPAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,48 @@

# NAME

tird - encrypt file contents and hide encrypted data among random data
tird - encrypt file contents and hide encrypted data

# SYNOPSIS

**tird** [**-d** | **--debug**]

# DESCRIPTION

**tird** _(an acronym for "this is random data")_ is a tool for encrypting file contents and hiding encrypted data among random data.
**tird** *(an acronym for "this is random data")* is a tool for encrypting file contents and hiding encrypted data.

**tird** can provide protection for individual files, including:

- symmetric encryption;
- reducing metadata leakage;
- hiding encrypted data;
- plausible deniability.

# COMMAND-LINE OPTIONS

#### -d, --debug

print debug messages

# GOALS

- Providing protection for individual files, including:
- symmetric encryption;
- reducing metadata leakage;
- hiding encrypted data;
- plausible deniability.
- Providing a stable encryption format with no cryptographic agility for long-term data storage.
- No feature creep: refusal to implement features that are not directly related to primary security goals.

# USAGE

Just run the script, select the option you want and then answer the questions.

# REQUIREMENTS

* Python >= 3.6
* PyNaCl >= 1.2.0
* PyCryptodomex >= 3.6.2
- Python >= 3.6
- PyNaCl >= 1.2.0
- PyCryptodomex >= 3.6.2

# REPORTING BUGS

Expand Down
34 changes: 31 additions & 3 deletions docs/tird.1
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,47 @@
.hy
.SH NAME
.PP
tird - encrypt file contents and hide encrypted data among random data
tird - encrypt file contents and hide encrypted data
.SH SYNOPSIS
.PP
\f[B]tird\f[R] [\f[B]-d\f[R] | \f[B]\[en]debug\f[R]]
.SH DESCRIPTION
.PP
\f[B]tird\f[R] \f[I](an acronym for \[lq]this is random data\[rq])\f[R]
is a tool for encrypting file contents and hiding encrypted data among
random data.
is a tool for encrypting file contents and hiding encrypted data.
.PP
\f[B]tird\f[R] can provide protection for individual files, including:
.IP \[bu] 2
symmetric encryption;
.IP \[bu] 2
reducing metadata leakage;
.IP \[bu] 2
hiding encrypted data;
.IP \[bu] 2
plausible deniability.
.SH COMMAND-LINE OPTIONS
.SS -d, \[en]debug
.PP
print debug messages
.SH GOALS
.IP \[bu] 2
Providing protection for individual files, including:
.RS 2
.IP \[bu] 2
symmetric encryption;
.IP \[bu] 2
reducing metadata leakage;
.IP \[bu] 2
hiding encrypted data;
.IP \[bu] 2
plausible deniability.
.RE
.IP \[bu] 2
Providing a stable encryption format with no cryptographic agility for
long-term data storage.
.IP \[bu] 2
No feature creep: refusal to implement features that are not directly
related to primary security goals.
.SH USAGE
.PP
Just run the script, select the option you want and then answer the
Expand Down

0 comments on commit d33004c

Please sign in to comment.