--help formatting, README fix
This commit is contained in:
parent
17d097ea74
commit
1dd4682029
14
README.md
14
README.md
@ -6,15 +6,17 @@ It generates a QR code (or a string) to verify OMEMO fingerprints.
|
|||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
```console
|
```console
|
||||||
./omemo-qrcode-gen [ Jabber ID ] [ Device ID ] [ Fingerprint ] [ [ Filename ] | [ qr ] | [ stdout ] ]
|
./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. ;)
|
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.
|
Requires qrencode and/or qr or even nothing.
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
# ./omemo-qrcode-gen [ Jabber ID ] [ Device ID ] "[ Fingerprint ]" [ filename.png or "qr" or "stdout" ]
|
||||||
# This will use qr to generate the QR code.
|
# This will use qr to generate the QR code.
|
||||||
./omemo-qrcode-gen john@example.com 12345678 "90123456 ABCDEF12 12345689 F0000000" qr
|
./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.
|
# This will use qrencode to generate the QR code and will save it into foo.png
|
||||||
./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 foo.png
|
||||||
# This will put the string into stdout
|
# 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
|
||||||
```
|
```
|
||||||
|
@ -7,7 +7,8 @@ STDOUT_TEXT="Type \"stdout\" to just put the string into stdout.\n"
|
|||||||
|
|
||||||
function helpme() {
|
function helpme() {
|
||||||
echo "$0 [ Jabber ID ] [ Device ID ] [ Fingerprint ] [ [ Filename.png ] | [ qr ] | [ stdout ] ]"
|
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 "Requires qrencode and/or qr or even nothing."
|
||||||
echo -e "\nExample:"
|
echo -e "\nExample:"
|
||||||
echo -e "# $0 [ Jabber ID ] [ Device ID ] \"[ Fingerprint ]\" [ filename.png or \"qr\" or \"stdout\" ] "
|
echo -e "# $0 [ Jabber ID ] [ Device ID ] \"[ Fingerprint ]\" [ filename.png or \"qr\" or \"stdout\" ] "
|
||||||
|
Loading…
Reference in New Issue
Block a user