Edit helps options; Edit README.md

2020-11-10 11:38:08 +01:00 · 2020-11-10 11:38:08 +01:00 · 4e100db6b3
parent 3cf3c8b8f2
commit 4e100db6b3
4 changed files with 73 additions and 23 deletions
--- a/README.md
+++ b/README.md
@ -3,21 +3,50 @@ Ceci est un testeur simple pour l'envoi de messages Cesium +
 # Utilisation

 ```
-chmod u+x sendmsg.sh
-./sendmsg.sh
+chmod u+x readmsg.sh sendmsg.sh deletemsg.sh
 ```
 Par défaut utilise l'émetteur, le fichier de trousseau ainsi que le noeud Cesium+ indiqué dans le fichier `.env`.
+Si non renseigné ni dans le fichier `.env` ni en argument de la commande, alors ils seront demandés interactivement.

-## Options
+## Lecture des messages
+```
+./readmsg.sh
+```
+
+### Options
+```
+    -r,--recipient <pubkey>	Uses <pubkey> as recipient of the messages.
+    -k,--key <key>		Path <key> to the pubsec keychain file of the issuer.
+    -n,--number <number>	Display the <number> lasts messages from Cesium (tail-like format)
+    -o,--outbox			Read outbox messages instead of inbox
+    -h,--help			Display this help
+```
+
+## Envoi de messages
 ```
 ./sendmsg.sh
-    Par défaut, demande le titre, le contenu et le destinataire en mode interactif.
-
-Options:
-    -t		Mode test: Utilise le fichier "test.txt" ainsi que le même destinataire que l'émetteur.
-    -f <file>	Lit le fichier <file> avec le titre en première ligne et le contenu dans le reste du fichier pour le message.
-    -r <pubkey>	Utilise <pubkey> comme destinataire du message.
-    -i <pubkey>	Utilise <pubkey> comme émetteur du message.
-    -k <key>	Chemin <key> vers le fichier de trousseau PubSec de l'émetteur.
-    -h		Affiche cette aide (en anglais).
+```
+
+### Options
+```
+    -t				Test mode: Uses the "test.txt" file as well as the same recipient as the sender.
+    -f,--file <file>		Read the file <file> with title in first line and content in rest of the file for the message.
+    -r,--recipient <pubkey>	Uses <pubkey> as recipient of the message.
+    -i,--issuer <pubkey>	Uses <pubkey> as issuer of the message (Could be remove in future version by calculating pubkey from privatekey).
+    -k,--key <key>		Path <key> to the pubsec keychain file of the issuer.
+    -h,--help			Display this help
+```
+
+## Suppression de messages
+```
+./sendmsg.sh
+```
+
+### Options
+```
+    -id,--id <ID du message>	Delete the message with ID <id>.
+    -i,--issuer <pubkey>	Uses <pubkey> as issuer of the message.
+    -k,--key <key>		Path <key> to the pubsec keychain file of the issuer.
+    -o,--outbox			Delete outbox messages instead of inbox
+    -h,--help			Display this help
 ```
--- a/deletemsg.sh
+++ b/deletemsg.sh
@ -9,13 +9,26 @@ source .env

 REGEX_PUBKEYS="[a-zA-Z0-9]{42,44}"

+# Help display
+helpOpt() {
+    echo -e "Cesium+ messages deleting
+    Default: ID in interactive mode.
+    Advice: Fill your .env file for more fun.
+    Example: $0 <ID du message>
+
+    \rOptions:
+    -id,--id <ID du message>\tDelete the message with ID <id>.
+    -i,--issuer <pubkey>\tUses <pubkey> as issuer of the message.
+    -k,--key <key>\t\tPath <key> to the pubsec keychain file of the issuer.
+    -o,--outbox\t\t\tDelete outbox messages instead of inbox
+    -h,--help\t\t\tDisplay this help"
+}
+
 # Parse options
 declare -a args=($@)
 for ((i=0; i<${#args[*]}; ++i))
 do
    case ${args[$i]} in
-        -t|--test) file="test.txt"
-            recipient=$issuer;;
 		-o|--outbox) type=outbox;;
        -id|--id) id="${args[$i+1]}"
            [[ -z $id ]] && echo "Veuillez préciser un ID de message." && exit 1;;
@ -23,6 +36,7 @@ do
            [[ -z $issuer ]] && echo "Veuillez préciser un émetteur." && exit 1;;
        -k|--key) dunikey="${args[$i+1]}"
            [[ -z $dunikey ]] && echo "Veuillez préciser un fichier de trousseau." && exit 1;;
+        -h|--help) helpOpt && exit 0;;
        *) [[ "${args[$i]}" == "-"* ]] && echo "Option inconnue." && exit 1;;
    esac
 done
@ -30,6 +44,7 @@ done
 if [[ -z $type ]]; then
    type="inbox"
 fi
+[[ -z $id ]] && id=$1
 if [[ -z $id ]]; then
    read -p "ID de message: " ID
 fi
--- a/readmsg.sh
+++ b/readmsg.sh
@ -11,13 +11,17 @@ source .env

 # Help display
 helpOpt() {
-    echo -e "This is a simple tester for Cesium+ messages sending
+    echo -e "Cesium+ messages sender
    \r$0
-    Default, ask title, content and recipient in interactive mode.
+    Default: ask recipient in interactive mode.
+    Advice: Fill your .env file for more fun.

    \rOptions:
    -r,--recipient <pubkey>\tUses <pubkey> as recipient of the messages.
-    -k,--key <key>\t\tPath <key> to the pubsec keychain file of the issuer."
+    -k,--key <key>\t\tPath <key> to the pubsec keychain file of the issuer.
+    -n,--number <number>\tDisplay the <number> lasts messages from Cesium (tail-like format)
+    -o,--outbox\t\t\tRead outbox messages instead of inbox
+    -h,--help\t\t\tDisplay this help"
 }

 REGEX_PUBKEYS="[a-zA-Z0-9]{42,44}"
@ -34,7 +38,7 @@ do
        -k|--key) dunikey="${args[$i+1]}"
            [[ -z $dunikey ]] && echo "Veuillez préciser un fichier de trousseau." && exit 1;;
        -o|--outbox) type=outbox;;
-        -n|--numbers) nbrRaw="${args[$i+1]}";;
+        -n|--number) nbrRaw="${args[$i+1]}";;
        -n*) nbrRaw="${args[$i]:2}";;
        -h|--help) helpOpt && exit 0;;
        *) [[ "${args[$i]}" == "-"* ]] && echo "Option inconnue." && exit 1;;
--- a/sendmsg.sh
+++ b/sendmsg.sh
@ -11,16 +11,18 @@ source .env

 # Help display
 helpOpt() {
-    echo -e "This is a simple tester for Cesium+ messages sending
-    \r$0
-    Default, ask title, content and recipient in interactive mode.
+    echo -e "Cesium+ messages sender
+    Default: ask title, content and recipient in interactive mode.
+    Advice: Fill your .env file for more fun.
+    Example: $0 -f <Path of file content message> -r <recipient pubkey> -i <issuer pubkey> -k <path of pubsec keychain of issuer>

    \rOptions:
    -t\t\t\t\tTest mode: Uses the \"test.txt\" file as well as the same recipient as the sender.
    -f,--file <file>\t\tRead the file <file> with title in first line and content in rest of the file for the message.
    -r,--recipient <pubkey>\tUses <pubkey> as recipient of the message.
-    -i,--issuer <pubkey>\tUses <pubkey> as issuer of the message.
-    -k,--key <key>\t\tPath <key> to the pubsec keychain file of the issuer."
+    -i,--issuer <pubkey>\tUses <pubkey> as issuer of the message (Could be remove in future version by calculating pubkey from privatekey).
+    -k,--key <key>\t\tPath <key> to the pubsec keychain file of the issuer.
+    -h,--help\t\t\tDisplay this help"
 }

 REGEX_PUBKEYS="[a-zA-Z0-9]{42,44}"