diff --git a/docs/MANPAGE.md b/docs/MANPAGE.md index 007c9cc..95468bd 100644 --- a/docs/MANPAGE.md +++ b/docs/MANPAGE.md @@ -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 for detailed descriptions and examples. + # GOALS - Providing protection for individual files, including: @@ -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. @@ -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 . + +# SPECIFICATION + +See . + # REPORTING BUGS Please report bugs at . diff --git a/docs/tird.1 b/docs/tird.1 index 50f9e64..a532daa 100644 --- a/docs/tird.1 +++ b/docs/tird.1 @@ -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 +for detailed descriptions and examples. .SH GOALS .IP \[bu] 2 Providing protection for individual files, including: @@ -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). @@ -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 +. +.SH SPECIFICATION +.PP +See . .SH REPORTING BUGS .PP Please report bugs at .