Skip to content

Commit

Permalink
Update manpage
Browse files Browse the repository at this point in the history
  • Loading branch information
hakavlad committed Jun 12, 2024
1 parent ad19b8e commit 9c89e44
Show file tree
Hide file tree
Showing 2 changed files with 70 additions and 0 deletions.
28 changes: 28 additions & 0 deletions docs/MANPAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,25 @@ Using **tird** you can:

print debug messages

# INPUT OPTIONS

- \[01] Select an action
- \[02] Use custom settings?
- \[03] Argon2 time cost
- \[04] Max padding size
- \[05] Set a fake MAC tag?
- \[06] Input file path
- \[07] Output file path
- \[08] Start position
- \[09] End position
- \[10] Comments
- \[11] Keyfile path
- \[12] Passphrase
- \[13] Proceed?
- \[14] Output file size

See <https://github.com/hakavlad/tird/blob/main/docs/INPUT_OPTIONS.md> for detailed descriptions and examples.

# GOALS

- Providing protection for individual files, including:
Expand Down Expand Up @@ -102,6 +121,7 @@ Enabling debug messages additionally shows:
- **tird** does not support ASCII armored output.
- **tird** does not support Reed–Solomon error correction.
- **tird** does not support splitting the output into chunks.
- **tird** does not support the use of standard streams for payload transmission.
- **tird** does not support low-level device reading and writing when used on MS Windows (devices cannot be used as keyfiles, cannot be overwritten, cannot be encrypted or hidden).
- **tird** does not provide a graphical user interface.
- **tird** does not provide a password generator.
Expand Down Expand Up @@ -129,6 +149,14 @@ Enabling debug messages additionally shows:
- PyNaCl >= 1.2.0
- PyCryptodomex >= 3.6.2

# TUTORAL

Step-by-step guides and examples you can see here <https://github.com/hakavlad/tird/blob/main/docs/tutorial/README.md>.

# SPECIFICATION

See <https://github.com/hakavlad/tird/blob/main/docs/SPECIFICATION.md>.

# REPORTING BUGS

Please report bugs at <https://github.com/hakavlad/tird/issues>.
Expand Down
42 changes: 42 additions & 0 deletions docs/tird.1
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,38 @@ box even if you encrypt files without hiding them in containers.
.SS -d, \[en]debug
.PP
print debug messages
.SH INPUT OPTIONS
.IP \[bu] 2
[01] Select an action
.IP \[bu] 2
[02] Use custom settings?
.IP \[bu] 2
[03] Argon2 time cost
.IP \[bu] 2
[04] Max padding size
.IP \[bu] 2
[05] Set a fake MAC tag?
.IP \[bu] 2
[06] Input file path
.IP \[bu] 2
[07] Output file path
.IP \[bu] 2
[08] Start position
.IP \[bu] 2
[09] End position
.IP \[bu] 2
[10] Comments
.IP \[bu] 2
[11] Keyfile path
.IP \[bu] 2
[12] Passphrase
.IP \[bu] 2
[13] Proceed?
.IP \[bu] 2
[14] Output file size
.PP
See <https://github.com/hakavlad/tird/blob/main/docs/INPUT_OPTIONS.md>
for detailed descriptions and examples.
.SH GOALS
.IP \[bu] 2
Providing protection for individual files, including:
Expand Down Expand Up @@ -158,6 +190,9 @@ some other info.
.IP \[bu] 2
\f[B]tird\f[R] does not support splitting the output into chunks.
.IP \[bu] 2
\f[B]tird\f[R] does not support the use of standard streams for payload
transmission.
.IP \[bu] 2
\f[B]tird\f[R] does not support low-level device reading and writing
when used on MS Windows (devices cannot be used as keyfiles, cannot be
overwritten, cannot be encrypted or hidden).
Expand Down Expand Up @@ -210,6 +245,13 @@ Python >= 3.6
PyNaCl >= 1.2.0
.IP \[bu] 2
PyCryptodomex >= 3.6.2
.SH TUTORAL
.PP
Step-by-step guides and examples you can see here
<https://github.com/hakavlad/tird/blob/main/docs/tutorial/README.md>.
.SH SPECIFICATION
.PP
See <https://github.com/hakavlad/tird/blob/main/docs/SPECIFICATION.md>.
.SH REPORTING BUGS
.PP
Please report bugs at <https://github.com/hakavlad/tird/issues>.
Expand Down

0 comments on commit 9c89e44

Please sign in to comment.