From 4a132b0c0a8f2cc808a3c01d5e25f1d0632580d0 Mon Sep 17 00:00:00 2001 From: Seppia Date: Wed, 31 Jan 2018 04:02:50 +0100 Subject: Fix README.md Updates README with new byte multiples function, fixes repository URL and name and fixes various typos. --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 29f6658..e86b1ac 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,12 @@ Capable of generating cryptographically strong random number keys and of usign t ## Build -To build onetimebluh just run `make` and You will find the executable binary in the build folder. +To build onetimebluh just run `make` and you will find the executable binary in the build folder. ## Install If you want to install onetimebluh, just run `make install`. -If you are using Archlinux onetimebluh is available in the [AUR](https://aur.archlinux.org/packages/otbluh-git/) and in my unofficial Archlinux repository [Seppianet](https://archlinux/seppia.net/). +If you are using Archlinux onetimebluh is available in the [AUR](https://aur.archlinux.org/packages/otbluh-git/) and in my unofficial Archlinux repository [seppianet](https://archlinux.seppia.net/). To use the repo simply add the following to you `pacman.conf` (currently the repo has only `x86_64` packages): @@ -22,16 +22,16 @@ Server = https://archlinux.seppia.net/$arch ## Usage -This example creates a `message` file of 4096 and a key of the same length (we are encrypting a pseudo random bytes file): +This example creates a `message` file of 4 KiB and a key of the same length (we are encrypting a pseudo random bytes file): ``` dd bs=512 count=8 if=/dev/urandom of=message -otbluh --key-gen --nbytes 4096 --output pad +otbluh --key-gen --nbytes 4K --output pad otbluh --encrypt message --key-file pad --output encrypted-message otbluh --decrypt encrypted-message --key-file pad --outptut decrypted-message ``` -Is recommended to use the `-t` option in order to be sure not to use more than once the same pieces of the pad to encrypt your data. Here follows an other example: +It is recommended to use the `-t` option in order to be sure not to use more than once the same pieces of the pad to encrypt your data. Here follows an other example: ``` otbluh --encrypt message --key-file pad --output encrypted-message --tear-page @@ -48,7 +48,7 @@ If you want you can use the `--bluh` function to get the binary dump of yuor enc otbluh --bluh message --output bluhed-message ``` -You can print the help by running `onetimebluh --help`. +You can print the help by running `otbluh --help`. ``` Onetimebluh usage: @@ -67,7 +67,7 @@ Options: -c, --char=CAHRS reads two cahracters as argument and uses them to bluh your message -k, --key-file=KEY_FILE use key (input) - -n, --nbytes=NUM number of bytes + -n, --nbytes=NUM{K,M,G,T} number of bytes, you can specify K for KiB, M for MiB, etc... -o, --output=FILE output name -t, --tear-page deletes from the pad file the bytes used to encrypt/decrypt -- cgit v1.2.3