--help formatting, README fix

This commit is contained in:
Bandie 2018-06-14 10:51:56 +02:00
parent 17d097ea74
commit 1dd4682029
Signed by: Bandie
GPG Key ID: C1E133BC65A822DD
2 changed files with 10 additions and 7 deletions

View File

@ -6,15 +6,17 @@ It generates a QR code (or a string) to verify OMEMO fingerprints.
## Usage
```console
./omemo-qrcode-gen [ Jabber ID ] [ Device ID ] [ Fingerprint ] [ [ Filename ] | [ qr ] | [ stdout ] ]
You can use ./omemo-qrcode-gen without any arguments or put all the needed arguments in here. Don't forget the quotation marks. ;)
./omemo-qrcode-gen [ Jabber ID ] [ Device ID ] [ Fingerprint ] [ [ Filename.png ] | [ qr ] | [ stdout ] ]
You can use ./omemo-qrcode-gen without any arguments or put all the needed arguments in here.
Don't forget the quotation marks. ;)
Requires qrencode and/or qr or even nothing.
Example:
# ./omemo-qrcode-gen [ Jabber ID ] [ Device ID ] "[ Fingerprint ]" [ filename.png or "qr" or "stdout" ]
# This will use qr to generate the QR code.
./omemo-qrcode-gen john@example.com 12345678 "90123456 ABCDEF12 12345689 F0000000" qr
# This will use qrencode to generate the QR code.
./omemo-qrcode-gen john@example.com 12345678 "90123456 ABCDEF12 12345689 F0000000" foo.png
./omemo-qrcode-gen bandie@example.com 9876543210 12345678 ABCDEF12 12345678 ABCDEF12 12345678 ABCDEF12 12345678 ABCDEF12 qr
# This will use qrencode to generate the QR code and will save it into foo.png
./omemo-qrcode-gen bandie@example.com 9876543210 12345678 ABCDEF12 12345678 ABCDEF12 12345678 ABCDEF12 12345678 ABCDEF12 foo.png
# This will put the string into stdout
./omemo-qrcode-gen john@example.com 12345678 "90123456 ABCDEF12 12345689 F0000000" stdout
./omemo-qrcode-gen bandie@example.com 9876543210 12345678 ABCDEF12 12345678 ABCDEF12 12345678 ABCDEF12 12345678 ABCDEF12 stdout
```

View File

@ -7,7 +7,8 @@ STDOUT_TEXT="Type \"stdout\" to just put the string into stdout.\n"
function helpme() {
echo "$0 [ Jabber ID ] [ Device ID ] [ Fingerprint ] [ [ Filename.png ] | [ qr ] | [ stdout ] ]"
echo "You can use $0 without any arguments or put all the needed arguments in here. Don't forget the quotation marks. ;)"
echo "You can use $0 without any arguments or put all the needed arguments in here."
echo "Don't forget the quotation marks. ;)"
echo "Requires qrencode and/or qr or even nothing."
echo -e "\nExample:"
echo -e "# $0 [ Jabber ID ] [ Device ID ] \"[ Fingerprint ]\" [ filename.png or \"qr\" or \"stdout\" ] "