aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/utils/README.md
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2016-05-22 01:47:56 +0300
committerEgor Tensin <Egor.Tensin@gmail.com>2016-05-22 01:47:56 +0300
commit308f9139bd358bd094ec9623f6e2bd3c16799594 (patch)
tree44408a2aaa346ab96241d5868bb0eeb888c633a0 /utils/README.md
parentREADME updates (diff)
downloadaes-tools-308f9139bd358bd094ec9623f6e2bd3c16799594.tar.gz
aes-tools-308f9139bd358bd094ec9623f6e2bd3c16799594.zip
README updates
Diffstat (limited to 'utils/README.md')
-rw-r--r--utils/README.md36
1 files changed, 14 insertions, 22 deletions
diff --git a/utils/README.md b/utils/README.md
index 312c754..6bf52f6 100644
--- a/utils/README.md
+++ b/utils/README.md
@@ -1,21 +1,15 @@
# Utilities
-A couple of useful utilities built on top of the library.
+A couple of useful utilities are built on top of the library.
Each of the utilities accepts the `--help` flag, which can be used to examine
the utility's usage info.
-The included utilities are:
-
-* [block encryption] utilities,
-* [file encryption] utilities,
-* and [bitmap encryption] utilities.
-
## Block encryption
Block encryption utilities can produce verbose human-readable output, including
round keys, intermediate initialization vector values, etc.
-Those are primarily intended for debugging purposes.
-Enable verbose output by passing the `--verbose` flag to a utilities.
+They are primarily intended for debugging purposes.
+Enable verbose output by passing the `--verbose` flag.
Please note that verbose output can only be produced when *not* using the
"boxes" interface (the `--use-boxes` flag).
@@ -136,30 +130,28 @@ Plaintext BMP | Encrypted in ECB mode | Encrypted in CBC mode
---------------- | --------------------- | ---------------------
![butterfly.bmp] | ![cipherfly_ecb.bmp] | ![cipherfly_cbc.bmp]
+[butterfly.bmp]: bmp/butterfly.bmp?raw=true
+[cipherfly_ecb.bmp]: bmp/cipherfly_ecb.bmp?raw=true
+[cipherfly_cbc.bmp]: bmp/cipherfly_cbc.bmp?raw=true
+
### encrypt_bmp.exe
Encrypts the pixels in a BMP image file, preserving the header.
The usage is the same as for [encrypt_file.exe].
+[encrypt_file.exe]: #encrypt_fileexe
+
### decrypt_bmp.exe
Decrypts the pixels in a BMP image file, preserving the header.
The usage is the same as for [decrypt_file.exe].
+[decrypt_file.exe]: #decrypt_fileexe
+
## See also
-* [Building]
+* [Building the utilities]
* [License]
-
-
-[building]: ../README.md#building
-[license]: ../README.md#license
-[block encryption]: #block-encryption
-[file encryption]: #file-encryption
-[bitmap encryption]: #bitmap-encryption
-[encrypt_file.exe]: #encrypt_fileexe
-[decrypt_file.exe]: #decrypt_fileexe
-[butterfly.bmp]: bmp/butterfly.bmp?raw=true
-[cipherfly_ecb.bmp]: bmp/cipherfly_ecb.bmp?raw=true
-[cipherfly_cbc.bmp]: bmp/cipherfly_cbc.bmp?raw=true
+[Building the utilities]: ../README.md#building-the-utilities
+[License]: ../README.md#license