aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2021-02-22 15:13:35 +0100
committerMattias Andrée <maandree@kth.se>2021-02-22 15:13:35 +0100
commitdd116f575bd7b6d2e65d9432f5268dbde3b85f0c (patch)
tree13fa84fa527f8c3cf977720684e6009207d70075
parentchange license + misc (diff)
downloadfile2key-dd116f575bd7b6d2e65d9432f5268dbde3b85f0c.tar.gz
file2key-dd116f575bd7b6d2e65d9432f5268dbde3b85f0c.tar.bz2
file2key-dd116f575bd7b6d2e65d9432f5268dbde3b85f0c.tar.xz
Update readme
Signed-off-by: Mattias Andrée <maandree@kth.se>
-rw-r--r--README26
1 files changed, 17 insertions, 9 deletions
diff --git a/README b/README
index a5acbab..3bf0ce5 100644
--- a/README
+++ b/README
@@ -1,13 +1,21 @@
-A simple command that generates a key from a file and a passphrase.
+NAME
+ file2key - generates a key from a file and a passphrase
-file2key uses Keccak[] to create a hash as big as a selected file
-and the prints the bitwise exclusive or of the hash and the file
-making a keyfile from any normal file and a passphrase. The idea
-is the reversed of steganography.
+SYNOPSIS
+ file2key [file]
-file2key cannot be configured. The idea behind this is that you
-if it required configurations you run the risk of losing all your
-keys if you lose your configurations. This must not happen.
+DESCRIPTION
+ file2key uses Keccak[] to create a hash as big as a
+ selected file and the prints the bitwise exclusive or
+ of the hash and the file making a key file from any
+ normal file and a passphrase.
-file2key can also be used to encrypt and decrypt files.
+ The idea is the reversed of steganography.
+ file2key can also be used to encrypt and decrypt files.
+
+RATIONALE
+ file2key cannot be configured. The idea behind this is
+ that you if it required configurations you run the risk
+ of losing all your keys if you lose your configurations.
+ This must not happen.